add code comments #139
add code comments #139
Conversation
|
I have added Matt and Frank for the review of documents to make sure it is what we are looking for, The issue this is addressing is Issue #62 |
There was a problem hiding this comment.
LGTM. Everything that is in it looks good. I think @fm-tibco and @mellistibco should see if they think anything more should be in the documentation. Thanks for doing this Samip!
action/api/api.go
Outdated
| @@ -8,16 +8,18 @@ import ( | |||
|
|
|||
| type Option func(*action.Config) | |||
|
|
|||
| //Initiliaize the action. | |||
There was a problem hiding this comment.
Take a look at https://blog.golang.org/godoc-documenting-go-code. We should probably follow their conventions for the go doc.
It states:
Notice this comment is a complete sentence that begins with the name of the element it describes. This important convention allows us to generate documentation in a variety of formats, from plain text to HTML to UNIX man pages, and makes it read better when tools truncate it for brevity, such as when they extract the first line or sentence.
No description provided.