BUX-538: Create Paymail add description #190
Conversation
|
Welcome to our open-source project @Nazarii-4chain! π |
Codecov ReportAll modified and coverable lines are covered by tests β
Additional details and impacted files@@ Coverage Diff @@
## master #190 +/- ##
=======================================
Coverage 59.91% 59.91%
=======================================
Files 16 16
Lines 978 978
=======================================
Hits 586 586
Misses 315 315
Partials 77 77
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report in Codecov by Sentry.
|
|
Welcome to our open-source project @Nazarii-4chain! π |
| // AdminCreatePaymail Create a paymail. | ||
| // | ||
| // Paymail address (ie. [email protected]) |
There was a problem hiding this comment.
I'm not sure why the comment is necessary for the AdminCreatePaymail when, at the same time, other methods (also public) are without a comment.
Besides that, the multiline comment looks to me like a separator between two groups of methods.
There was a problem hiding this comment.
Comment should show an example of paymail address. Removed new line
There was a problem hiding this comment.
But, as I see in the whole AdminService package documentation - not only the AdminCreatePaymail gets an address as string which should be a paymail.
So maybe an example how paymailAddress looks like would be in the AdminService description, like that:
// AdminService is the admin related requests
//
// Note: A Paymail address is a unique identifier for receiving payments in the
// form of a readable email-like address (e.g., [email protected]).
https://pkg.go.dev/github.com/BuxOrg/[email protected]/transports#AdminService
There was a problem hiding this comment.
I've added this to show an example for users how paymail should look like.
There was a problem hiding this comment.
Because of the task is about just adding a comment/desc to AdminCreatePaymail - agreed, it's ok π
But I'm seeing some inconsistency, why some methods are commented and other not. But maybe it will be resolved by next tasks in the future.
Co-authored-by: chris-4chain <[email protected]>
Added description
Pull Request Checklist