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

Missing parameter docstrings #11

Closed
FoamyGuy opened this issue Jul 17, 2023 · 0 comments · Fixed by #19
Closed

Missing parameter docstrings #11

FoamyGuy opened this issue Jul 17, 2023 · 0 comments · Fixed by #19
Labels
documentation Improvements or additions to documentation

Comments

@FoamyGuy
Copy link
Contributor

This library appears to be missing parameter docstrings for the init and other functions with arguments.

For the class they can be added to the main docstring here: https://github.com/adafruit/Adafruit_CircuitPython_Dash_Display/blob/main/adafruit_dash_display.py#L44

e.g.:

:param str key: The Adafruit IO feed key
:param str default_text: Text to display before data has been pulled from Adafruit IO
...
@FoamyGuy FoamyGuy added the good first issue Good for newcomers label Jul 24, 2023
@adafruit-adabot adafruit-adabot added the Hacktoberfest DigitalOcean's Hacktoberfest label Sep 29, 2023
@dhalbert dhalbert added documentation Improvements or additions to documentation and removed good first issue Good for newcomers Hacktoberfest DigitalOcean's Hacktoberfest labels Mar 25, 2024
@FoamyGuy FoamyGuy mentioned this issue Nov 26, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs and types adafruit/Adafruit_CircuitPython_Dash_Display
3 participants
@FoamyGuy @dhalbert @adafruit-adabot