Comments (5)
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:
-
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.
-
Note that godoc uses those comments to generate documentation.
-
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.
Related Issues (20)
- Example usage: Set DHCP options HOT 1
- CHANGELOG.md
- Segfault due to missing error check with bad HostConfig settings HOT 1
- Vlan support
- `develop` branch can be removed
- Use option structs instead of arguments HOT 1
- support grid api
- does this client support batch requests? HOT 1
- Add GitHub Action as a CI/CD tool for pull requests
- Kind request for a release HOT 4
- Make SearchHostRecordByAltId method more generic
- Fake client for unit testing or more exported fields HOT 1
- Search All capabilities? HOT 1
- v2 introduced long timeout when fetching A record HOT 1
- Add useful fields for Authoritative Zone resource
- Which func to use to get all networks/cidr? HOT 2
- searching for records using regex HOT 12
- which API is used to find associated network view for a given dns_view? HOT 3
- Add RecordNS support to the go client
- problem on tls: unsupported protocol version 301' HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from infoblox-go-client.