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

Change docstrings to reference constants and not their literal values #589

Open
1 task
SamWilsn opened this issue Aug 22, 2022 · 1 comment
Open
1 task

Change docstrings to reference constants and not their literal values #589

SamWilsn opened this issue Aug 22, 2022 · 1 comment
Labels
A-doc Area: documentation C-enhance Category: a request for an improvement E-easy Experience: easy, good for newcomers

Comments

@SamWilsn
Copy link
Collaborator

SamWilsn commented Aug 22, 2022 •
edited
Loading

The value of constants may change, and then the docstring will be out of date. We should never have a literal value in a docstring.

Non-exhaustive list of places to fix:

Originally posted by @petertdavies in #581 (comment)
@SamWilsn SamWilsn added A-doc Area: documentation C-enhance Category: a request for an improvement E-easy Experience: easy, good for newcomers labels Aug 22, 2022
@Redidacove
Copy link
Contributor

Means what kind of changes are you expecting, can you give some example changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-doc Area: documentation C-enhance Category: a request for an improvement E-easy Experience: easy, good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@SamWilsn @Redidacove