Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove requirement to document implementations of official GO packages #2024

Closed
plandem opened this issue Jul 20, 2018 · 4 comments
Closed

Comments

@plandem
Copy link
Contributor

plandem commented Jul 20, 2018

#2013

Do you really think that this is somehow related to quality of code or documentation?

What the reason to require document implementation of standard interfaces? E.g.:

MarshalXMLAttr
UnmarshalXMLAttr

From my point of view, It's just faking/cheating system and has nothing about quality of code or documentation.

P.S.: I can give you bunch of packages from awesome-go list that don't even have link to http://goreportcard.com, but the same time you are strict on new packages about such things like comments for MarshalXMLAttr or UnmarshalXMLAttr.

@kirillDanshin
Copy link
Contributor

@plandem sorry, but no, it's not what we're going to do. this is basic golint rules, if you want to add some exceptions - please create issue in the golint repo

@kirillDanshin
Copy link
Contributor

UPD: @plandem see #2036

@plandem
Copy link
Contributor Author

plandem commented Jul 26, 2018

So it's fine to have packages here without http://goreportcard.com at all, but for new packages you are asking to comment standard implementation?!

@plandem
Copy link
Contributor Author

plandem commented Jul 26, 2018

ok, got you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants