Skip to content

Fix #32 #34

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.

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

Merged
merged 11 commits into from
Jun 18, 2022
Merged

Fix #32 #34

merged 11 commits into from
Jun 18, 2022

Conversation

JulianOrteil
Copy link
Contributor

Addresses #32.

I also changed docstrings to better conform to PEP257. The style I chose should conform nicely to sphinx as I wasn't able to determine a standard set with this library.

@ladyada ladyada requested a review from FoamyGuy June 5, 2022 20:07
Copy link
Contributor

@FoamyGuy FoamyGuy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this @JulianOrteil!

I have a few changes to request. We'll try to get this tested out as well to ensure some of the new type annotations that haven't been used before won't cause trouble.

@JulianOrteil
Copy link
Contributor Author

@FoamyGuy Other adafruit libraries use the sphinx docstring style (i.e. :param int myvariable: A description of myvariable). Do you wish for me to use this style here?

@FoamyGuy
Copy link
Contributor

@JulianOrteil Yes, thank you. We use sphinx to build the documentation pages, so we should follow that syntax.

@JulianOrteil
Copy link
Contributor Author

@FoamyGuy All changes have been implemented. Depending on your answer to my question on 105 and 106, this PR should be ready to merge at your leisure :)

Copy link
Contributor

@FoamyGuy FoamyGuy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks for all of your work on this @JulianOrteil!

@FoamyGuy FoamyGuy merged commit 91a5b7b into adafruit:main Jun 18, 2022
@JulianOrteil JulianOrteil deleted the fix-32 branch June 18, 2022 16:48
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Jun 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants