Skip to content

Fix documentation #55

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
Merged
merged 3 commits into from
Mar 29, 2022
Merged

Fix documentation #55

merged 3 commits into from
Mar 29, 2022

Conversation

Neradoc
Copy link
Contributor

@Neradoc Neradoc commented Mar 28, 2022

Missing new lines for parameters list.
Lists all submodules in APIs.

tekktrik
tekktrik reviewed Mar 28, 2022
View reviewed changes
adafruit_wiznet5k/adafruit_wiznet5k_ntp.py
@@ -3,7 +3,7 @@
# SPDX-License-Identifier: MIT

"""
`wiznet5k_ntp`
Copy link
Member

Choose a reason for hiding this comment

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

Nice catch!

tekktrik
tekktrik requested changes Mar 28, 2022
View reviewed changes
Copy link
Member

@tekktrik tekktrik left a comment

Choose a reason for hiding this comment

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

Nice catches! Only thing I noticed is that :returns: should be :return: I believe. I think that goes for all the uses of :returns: in this library, unfortunately.

adafruit_wiznet5k/adafruit_wiznet5k_socket.py
:param bytearray buf: Data buffer
:param nbytes: Maximum number of bytes to receive
:param int flags: ignored, present for compatibility.
:returns a tuple (nbytes, address) where address is a tuple (ip, port)
Copy link
Member

Choose a reason for hiding this comment

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

I believe this should be :return:

@Neradoc
Copy link
Contributor Author

Neradoc commented Mar 28, 2022

:returns: renders the same as :return: so I didn't touch them, but I agree, they should be consistent. I'll do that.

@tekktrik
Copy link
Member

:returns: renders the same as :return: so I didn't touch them, but I agree, they should be consistent. I'll do that.

Oh, good to know!

@tekktrik
Copy link
Member

@Neradoc looks like the new black wants to reformat something, wanna run pre-commit again?

@tekktrik
Copy link
Member

Pre-commit is the new black 🤣 Thanks!

@tekktrik tekktrik merged commit 450c52e into adafruit:main Mar 29, 2022
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Mar 30, 2022
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@d21f7d6)
6b89246 
Updating https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15 to 2.2.13 from 2.2.12:
  > Merge pull request adafruit/Adafruit_CircuitPython_ADS1x15#79 from Neradoc/fix-documentation
  > Update Black to latest.
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_DHT to 3.7.2 from 3.7.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_DHT#83 from Neradoc/fix-documentation
  > Update Black to latest.
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_DS18X20 to 1.3.10 from 1.3.9:
  > Merge pull request adafruit/Adafruit_CircuitPython_DS18X20#26 from Neradoc/fix-documentation
  > Update Black to latest.
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_FONA to 2.1.7 from 2.1.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_FONA#17 from Neradoc/fix-documentation
  > Update Black to latest.

Updating https://github.com/adafruit/Adafruit_CircuitPython_HTU21D to 0.11.4 from 0.11.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_HTU21D#19 from Neradoc/fix-documentation
  > Update Black to latest.
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_LIDARLite to 1.2.8 from 1.2.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_LIDARLite#18 from Neradoc/fix-documentation
  > Update Black to latest.
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_Wiznet5k to 1.12.5 from 1.12.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_Wiznet5k#55 from Neradoc/fix-documentation-params
  > Update Black to latest.

Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA:
  > Added the following libraries: Adafruit_CircuitPython_TSC2007
@Neradoc Neradoc deleted the fix-documentation-params branch April 22, 2022 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brentru brentru brentru approved these changes

@tekktrik tekktrik tekktrik approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Neradoc @tekktrik @brentru