Update commets

Author: maratori

async.go

@@ -36,10 +36,10 @@ func NewExecutor() *Executor {
 }
 
 // Register returns a handler to call a method on the receiver.
-// The handler should be registered in jobs processor.
+// The handler should be registered in a jobs processor.
 //
 // Method is a func that takes receiver as the first input parameter.
-// The next input parameter may optionally be context.Context.
+// The next input parameter may optionally be [context.Context].
 // It optionally may return an error (or a type implementing error interface).
 //
 // Receiver should have the same type as the first parameter of the method.
@@ -115,7 +115,7 @@ func (e *Executor) Register( //nolint:gocognit // TODO: simplify
 
 // Prepare returns jobName and marshaled args to be enqueued.
 //
-// Arguments are serialized to be saved inside jobs storage.
+// Arguments are serialized to be saved inside a jobs storage.
 // It is a bad practice to use domain types as a transport ones directly.
 // So library limits allowed types as much as possible.
 // However, it still may be error-prone, see test "using iota is dangerous".

async_test.go

@@ -24,10 +24,10 @@ func TestExecutor(t *testing.T) {
 			executor := async.NewExecutor()
 			_, err := executor.Register("job", domainService, DomainService.Struct__MyEnum__Nothing)
 			require.NoError(t, err)
-			// Under the hood MyEnumB is converted to `2` and is stored for the future execution.
-			// If someone adds/removes enum const before MyEnumB, it changes numbering (actual values of enums).
-			// It means that once job enqueued with argument `2` (meaning MyEnumB) will be executed with argument 2.
-			// But now it means not MyEnumB, but some different enum const.
+			// Under the hood [MyEnumB] is converted to `2` and is stored for the future execution.
+			// If someone adds/removes enum const before [MyEnumB], it changes numbering (actual values of enums).
+			// It means that once job enqueued with argument `2` (meaning [MyEnumB]) will be executed with argument 2.
+			// But now it means not [MyEnumB], but some different enum const.
 			_, args, err := executor.Prepare(DomainService.Struct__MyEnum__Nothing, MyEnumB)
 			require.NoError(t, err)
 			assert.JSONEq(t, `{"arg0":2,"type0":"int"}`, string(args))