Make golint happy about infoblox-go-client HOT 5 OPEN

I feel lint errors like "exported method NetworkViewLock.Lock should have comment or be unexported" are bit silly. Many of the times methods/functions are self explanatory. Adding comments dont really add any value at times. just my view.

from infoblox-go-client.

I understand what you mean. I bring it up because I feel it is helpful to have golint in my pre-commit checklist in order to more easily catch code that does not look like idiomatic Go before sending patches.

from infoblox-go-client.

Agreed we should make go-lint happy.

from infoblox-go-client.

Agreed also!

Additional reasons:

1. Sometimes even it might look self explanatory to the coder, there is typically details that might not be so obvious for a new comer to the code - these details should be included in those comments.

2. Note that godoc uses those comments to generate documentation.

3. Consistency is a good thing.

from infoblox-go-client.

I have gone through the golint output and opened PRs for all the internal stuff that can be modified without thinking about external dependencies. I have also documented the external Logout method that I was responsible for adding.

I do not plan on touching any of the exported functions/methods/struct fields since this breaks the current contract with library users and therefore requires a higher level of coordination. I also think that documentation for exported functions is better handled by the function authors instead of me doing more or less qualified guesswork.

from infoblox-go-client.