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

Add single-line docstrings for loggers #171

Open
mcw92 opened this issue Jan 7, 2025 · 0 comments
Open

Add single-line docstrings for loggers #171

mcw92 opened this issue Jan 7, 2025 · 0 comments
Assignees
@mcw92
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Documentation

Comments

@mcw92
Copy link
Member

mcw92 commented Jan 7, 2025

Is your feature request related to a problem? Please describe.
The logger objects used in the Propulate package currently appear without description in the automatically generated API references on ReadTheDocs (e.g., here).

Describe the solution you'd like
Add single-line docstrings to the lines where the logger objects are defined.
@mcw92 mcw92 added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 7, 2025
@mcw92 mcw92 added this to the Documentation milestone Jan 7, 2025
@mcw92 mcw92 self-assigned this Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mcw92 mcw92

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
Documentation
Development

No branches or pull requests
1 participant
@mcw92