Rewrite properties documentation #7
Merged
Conversation
This file contains hidden or 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
ladyada
approved these changes
Jun 2, 2020
tannewt
requested changes
Jun 2, 2020
adafruit_fona/adafruit_fona.py
Outdated
Comment on lines
376
to
378
| def gps(self, gps_on=False): | ||
| """Sets GPS module power, parses returned buffer. | ||
| """Enables or disables GPS module. | ||
| :param bool gps_on: Enables the GPS module, disabled by default. |
There was a problem hiding this comment.
A param here doesn't make sense because it's a setter. The default argument is unneeded because it's always provided.
There was a problem hiding this comment.
Also, I think this doc string is ignored in favor of the getter's doc string.
There was a problem hiding this comment.
@tannewt Would this be the case with all setters?
There was a problem hiding this comment.
Ok, thanks. Did a pass removing docstrings + parameters for setters.
tannewt
reviewed
Jun 3, 2020
|
@brentru Please follow up on this PR. Thanks! |
tannewt
approved these changes
Sep 24, 2020
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Sep 25, 2020
Updating https://github.com/adafruit/Adafruit_CircuitPython_FONA to 2.1.0 from 2.0.1: > Merge pull request adafruit/Adafruit_CircuitPython_FONA#7 from brentru/update-property-docstrings Updating https://github.com/adafruit/Adafruit_CircuitPython_Requests to 1.7.2 from 1.7.1: > Merge pull request adafruit/Adafruit_CircuitPython_Requests#36 from tannewt/check_send
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.
Rewrite property documentation to treat them like attributes per @tannewt's advice.