Merge pull request #1 from somatech1/docs/improvements

docs: improve documentation

Author: rsfreitas

README.md

@@ -2,7 +2,7 @@
 
 ## About the project
 
-`mikro\_s` is a Go framework for creating applications.
+`mikro_s` is a Go framework for creating applications.
 
 ## Contributing
 

service.go

@@ -591,18 +591,18 @@ func (s *Service) stopDependentServices(ctx context.Context) error {
 	return nil
 }
 
-// Logger gives access to the utils/logger API from inside a service context.
+// Logger gives access to the logger API from inside a service context.
 func (s *Service) Logger() loggerApi.Logger {
 	return s.logger
 }
 
-// Errors gives access to the utils/errors API from inside a service context.
+// Errors gives access to the errors API from inside a service context.
 func (s *Service) Errors() errorsApi.ErrorFactory {
 	return s.errors
 }
 
-// Abort is a helper method to abort services in the right way, in external
-// initialization, when an error checking is required.
+// Abort is a helper method to abort services in the right way, when external
+// initialization is needed.
 func (s *Service) Abort(message string, err error) {
 	s.abort(context.TODO(), merrors.NewAbortError(message, err))
 }
@@ -701,8 +701,8 @@ func (s *Service) SetupTest(ctx context.Context, t *testing.Testing) *ServiceTes
 	return setupServiceTesting(ctx, s, t)
 }
 
-// CustomDefinitions gives the service access to its custom settings that
-// it may have put inside the 'service.toml' file.
+// CustomDefinitions gives the service access to the service custom settings
+// that it may have put inside the 'service.toml' file.
 //
 // Note that these settings correspond to everything under the [service]
 // object inside the TOML file.

testing.go

@@ -8,8 +8,10 @@ import (
 	"github.com/somatech1/mikros/components/testing"
 )
 
-// ServiceTesting is an object by a Service.SetupTest call. It should be used
-// to create unit tests that needs to use features (internal or external).
+// ServiceTesting is an object created by a Service.SetupTest call.
+//
+// It should be used when creating unit tests that need to use features,
+// internal or external, and require some kind of setup/teardown mechanism.
 type ServiceTesting struct {
 	svc  *Service
 	test *testing.Testing
@@ -36,7 +38,7 @@ func setupServiceTesting(ctx context.Context, svc *Service, t *testing.Testing)
 	return svcTest
 }
 
-// Teardown releases every resource allocated in the SetupTest call.
+// Teardown releases every resource allocated by the SetupTest call.
 func (s *ServiceTesting) Teardown(ctx context.Context) {
 	iter := s.svc.features.Iterator()
 	for p, next := iter.Next(); next; p, next = iter.Next() {