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

Fix docstring lints as reported by internal linter. #180

Merged
merged 4 commits into from
Sep 20, 2024

Conversation

reventlov
Copy link
Collaborator

No description provided.

@reventlov reventlov requested a review from EricRahm September 19, 2024 19:34
Copy link
Collaborator

@EricRahm EricRahm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we can run these checks in ci, I'm not a huge fan of them in the first place but I get that downstream wants them.

@reventlov
Copy link
Collaborator Author

I wonder if we can run these checks in ci, I'm not a huge fan of them in the first place but I get that downstream wants them.

I like the lint that makes sure that docstrings are correctly formatted when present. I'm not a big fan of requiring a docstring on every single function, especially private functions, but I didn't feel like being picky on this particular PR.

Downstream, the lints are an annoyance, but not a major problem. It should also be possible to turn them off, but I haven't taken the time to figure out how.

@reventlov reventlov merged commit 800bd4a into google:master Sep 20, 2024
4 checks passed
@reventlov reventlov deleted the pylint_docstrings branch October 10, 2024 18:42
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

Successfully merging this pull request may close these issues.

2 participants