Use :rtype: to clarify types returned because of __get__() #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`UnaryStruct` uses __get__() to return a different type, but this is unclear currently because now that these variable have type annotations, class variable utilizing ot are automatically typed as `UnaryStruct`. While one option is to manually document the class variables, I think it's preferable to use an attached docstring so the documentation and code don't ever get split up if one is removed for some reason. Using Sphinx `rtype` seems to be the best way to document it then.
dhalbert
approved these changes
Feb 18, 2022
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Feb 19, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_AS7341 to 1.2.6 from 1.2.5: > Merge pull request adafruit/Adafruit_CircuitPython_AS7341#29 from tekktrik/fix-python-version > Merge pull request adafruit/Adafruit_CircuitPython_AS7341#28 from tekktrik/doc/fix-cvar-typing Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE_Apple_Media to 0.9.7 from 0.9.6: > Merge pull request adafruit/Adafruit_CircuitPython_BLE_Apple_Media#13 from tekktrik/dev/fix-issue8 > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_BusDevice to 5.1.7 from 5.1.6: > Merge pull request adafruit/Adafruit_CircuitPython_BusDevice#85 from tekktrik/hotfix/require-python-version Updating https://github.com/adafruit/Adafruit_CircuitPython_Debug_I2C to 1.2.9 from 1.2.8: > Merge pull request adafruit/Adafruit_CircuitPython_Debug_I2C#14 from tekktrik/dev/add-python-ver Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Text to 2.22.1 from 2.22.0: > Merge pull request adafruit/Adafruit_CircuitPython_Display_Text#165 from tekktrik/add-missing-dependency > Fixed readthedocs build Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA: > Added the following libraries: Adafruit_CircuitPython_ESP32S2TFT
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #26
UnaryStructuses__get__()to return a different type, but this is unclear currently because now that these variable have type annotations, class variable utilizing it are automatically typed asUnaryStruct.While one option is to manually document the class variables, I think it's preferable to use an attached docstring so the documentation and code don't ever get split up if one is removed for some reason. Using Sphinx
:rtype:seems to be the best way to document it then.