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

Docstrings: imperative to descriptive #60

Open
GilesStrong opened this issue Jun 6, 2020 · 0 comments
Open

Docstrings: imperative to descriptive #60

GilesStrong opened this issue Jun 6, 2020 · 0 comments
Labels
low priority Not urgent and won't degrade with time

Comments

@GilesStrong
Copy link
Owner

When writing doc-strings, I begun using imperative strings, e.g "Plot KDEs computed via :meth:~lumin.utils.statistics.bootstrap_stats". Following a recommendation I then switched to writing descriptive doc-strings, e.g. "Plots KDEs computed via :meth:~lumin.utils.statistics.bootstrap_stats".

Ideally the style should be consistent for all doc-strings, so the old ones need to be updated.
@GilesStrong GilesStrong added the low priority Not urgent and won't degrade with time label Jun 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
low priority Not urgent and won't degrade with time
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GilesStrong