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.

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

Corrections to receive_n_data documentation #114

Merged
merged 1 commit into from
Dec 21, 2023
Merged

Corrections to receive_n_data documentation #114

merged 1 commit into from
Dec 21, 2023

Conversation

kavinaidoo
Copy link
Contributor

Hi,

Thank you for approving my PR, it's my first ever and I am happy that I have added helpful functionality.

Unfortuately, upon reviewing the docs, I found some omissions that now are corrected in this PR:

receive_n_data - Link to Docs

  • Parameter description for n_values was missing, this has been added.
  • Wording changes to specify "most recent n" to remove any ambiguity

validate_n_values - Link to docs

  • Removed line breaks for better formatting in docs.

Thanks

receive_n_data
- added missing n_values :param
- changed description for more accurate wording

validate_n_values
- changed description for better formatting in docs
@kavinaidoo kavinaidoo changed the title corrections to receive_n_data documentation Corrections to receive_n_data documentation Dec 20, 2023
@kavinaidoo kavinaidoo marked this pull request as ready for review December 20, 2023 17:55
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.

Thank you for the clarifications!

Looks good to me.

@FoamyGuy FoamyGuy merged commit 7512838 into adafruit:main Dec 21, 2023
1 check passed
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Jan 9, 2024
Updating https://github.com/adafruit/Adafruit_CircuitPython_24LC32 to 1.1.0 from 1.0.12:
  > Merge pull request adafruit/Adafruit_CircuitPython_24LC32#23 from TonyLHansen/main

Updating https://github.com/adafruit/Adafruit_CircuitPython_ADT7410 to 2.0.0 from 1.3.13:
  > Merge pull request adafruit/Adafruit_CircuitPython_ADT7410#24 from jposada202020/improving_lib

Updating https://github.com/adafruit/Adafruit_CircuitPython_CLUE to 3.1.0 from 3.0.17:
  > Merge pull request adafruit/Adafruit_CircuitPython_CLUE#61 from prcutler/root-group-fix

Updating https://github.com/adafruit/Adafruit_CircuitPython_PCA9685 to 3.4.14 from 3.4.13:
  > Merge pull request adafruit/Adafruit_CircuitPython_PCA9685#59 from bdlucas1/main

Updating https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO to 5.8.1 from 5.8.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_AdafruitIO#114 from kavinaidoo/main

Updating https://github.com/adafruit/Adafruit_CircuitPython_asyncio to 1.3.0 from 1.2.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_asyncio#59 from imnotjames/chore/optional-traceback

Updating https://github.com/adafruit/Adafruit_CircuitPython_PyCamera to 0.0.7 from 0.0.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_PyCamera#15 from adafruit/enhancements
  > Merge pull request adafruit/Adafruit_CircuitPython_PyCamera#13 from brentru/allow-jpg-save

Updating https://github.com/adafruit/Adafruit_CircuitPython_TemplateEngine to 1.1.0 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_TemplateEngine#2 from michalpokusa/removing-8-x-x-re-module-bug-workarounds

Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA:
  > Updated download stats for the libraries
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