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.

Sign up for GitHub

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

Jump to bottom

[Two-Fer] Remap Pylint Warnings about Docstrings from ACTIONABLE to INFORM #25

Open
BethanyG opened this issue Apr 16, 2021 · 0 comments
Open

[Two-Fer] Remap Pylint Warnings about Docstrings from ACTIONABLE to INFORM #25

BethanyG opened this issue Apr 16, 2021 · 0 comments
Assignees
@BethanyG

Comments

@BethanyG
Copy link
Member

Currently, pylint feedback for this exercise flags comments about missing module and method/function docstrings as ACTONABLE.

We should re-map these to INFORM comments instead, and have those comments link to docs that describe why docstrings are important, in addition to a docstring concept exercise, when it is ready.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@BethanyG BethanyG

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@BethanyG