Closed thinkingserious closed 3 years ago
The //
prefix is necessary for the comments, but not the *
, those were added for better visual clarity:
Generated Docs: http://localhost:6060/pkg/github.com/twilio/twilio-go/twilio/rest/accounts/v1/#DefaultApiService.CreateCredentialAws
Without the*
's:
If we add the * to just the #Notes section we get:
From the resources mentioned here, I think we should remove the param/return stuff from the func comments. Params type should be updated to have inline comments on each field, similar to what is done for the models.
From the resources mentioned here, I think we should remove the param/return stuff from the func comments. Params type should be updated to have inline comments on each field, similar to what is done for the models.
What about the comments for the path params, which do not belong to params?
What about the comments for the path params, which do not belong to
params?
I'm okay with leaving them out since they're pretty self-documenting by their name. We can always add more details later.
Generated by https://github.com/twilio/twilio-oai-generator/pull/37
Update godocs formatting.
Checklist