Skip to content

Hyperspecify targets in documentation #167

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 1 commit into from
Jun 1, 2022
Merged

Hyperspecify targets in documentation #167

merged 1 commit into from
Jun 1, 2022

Conversation

tekktrik
Copy link
Member

@tekktrik tekktrik commented Jun 1, 2022

Will resolve documentation issues in other libraries that don't have their own docstrings for match_prefixes

Copy link
Collaborator

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

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

Suggestion of slightly shorter hyper-specification

@tekktrik
Copy link
Member Author

tekktrik commented Jun 1, 2022

I tried the suggestions locally, and it failed to build the documentation as it considers them not specific enough. :/ I can commit them and see if CI will behave differently though.

@tekktrik tekktrik requested a review from dhalbert June 1, 2022 01:26
@dhalbert
Copy link
Collaborator

dhalbert commented Jun 1, 2022

I tried the suggestions locally, and it failed to build the documentation as it considers them not specific enough. :/ I can commit them and see if CI will behave differently though.

No, that's fine. I had hoped...

Copy link
Collaborator

@dhalbert dhalbert 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 all these fixes!

@dhalbert dhalbert merged commit 6d66d2f into adafruit:main Jun 1, 2022
@tekktrik
Copy link
Member Author

tekktrik commented Jun 1, 2022

My pleasure!

adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Jun 1, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_floppy to 1.0.2 from 1.0.1:
  > Set language to "en" for documentation
  > Merge pull request adafruit/Adafruit_CircuitPython_floppy#4 from tekktrik/dev/lint-example
  > Update .pre-commit-config.yaml
  > Fix Docs badge
  > fix discord link for RTD
  > fix python version for rtd

Updating https://github.com/adafruit/Adafruit_CircuitPython_HT16K33 to 4.3.1 from 4.3.0:
  > Set language to "en" for documentation
  > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#99 from makermelissa/master
  > Switch to inclusive terminology
  > Increase min lines similarity
  > Patch .pre-commit-config.yaml
  > change discord badge
  > Patch: Replaced discord badge image
  > Updated gitignore
  > Update Black to latest.
  > Fixed readthedocs build

Updating https://github.com/adafruit/Adafruit_CircuitPython_VL53L1X to 1.1.2 from 1.1.1:
  > Set language to "en" for documentation
  > Merge pull request adafruit/Adafruit_CircuitPython_VL53L1X#8 from caternuson/iss7_range_check
  > Increase min lines similarity
  > Patch .pre-commit-config.yaml

Updating https://github.com/adafruit/Adafruit_CircuitPython_Wiznet5k to 1.12.6 from 1.12.5:
  > Set language to "en" for documentation
  > Switch to inclusive terminology
  > Increase min lines similarity
  > Merge pull request adafruit/Adafruit_CircuitPython_Wiznet5k#58 from rstein/fix_sending_when_offset_greater_than_socksize
  > Patch .pre-commit-config.yaml
  > change discord badge
  > Patch: Replaced discord badge image
  > Update .gitignore

Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE to 8.3.2 from 8.3.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_BLE#167 from tekktrik/doc/hyperspecific-targets

Updating https://github.com/adafruit/Adafruit_CircuitPython_JWT to 1.2.7 from 1.2.6:
  > Set language to "en" for documentation
  > Merge pull request adafruit/Adafruit_CircuitPython_JWT#14 from Neradoc/add-deps
  > Switch to inclusive terminology
  > Increase min lines similarity
  > Patch .pre-commit-config.yaml

Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA:
  > Added the following libraries: Adafruit_CircuitPython_floppy
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