now renders API Reference page correctly #17
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
autodocs showing inheritence, but `AnalogIn.__init__()`'s `positive_pin` & `negative_pin` parameters are not DigitalInOut objects
brentru
reviewed
Oct 10, 2019
brentru
reviewed
Oct 10, 2019
brentru
reviewed
Oct 10, 2019
|
I can't open the conflicting example file here on the PR to see how removing one argument on one line would cause a conflict. |
|
OK not sure how it happened or even how I resolved it, but using |
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Oct 14, 2019
Updating https://github.com/adafruit/Adafruit_CircuitPython_MCP3xxx to 1.1.2 from 1.1.1: > Merge pull request adafruit/Adafruit_CircuitPython_MCP3xxx#17 from 2bndy5/master Updating https://github.com/adafruit/Adafruit_CircuitPython_RA8875 to 2.0.1 from 2.0.0: > Merge pull request adafruit/Adafruit_CircuitPython_RA8875#13 from makermelissa/master Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA: > Added the following libraries: Adafruit_CircuitPython_AWS_IOT
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.
Looking at the PR of this library in the past, I see the @sommersoft opened issue #7 that had suggested adequate changes to api.rst, but it was closed upon merge of this PR without including the suggested changes. So I did exactly that and then some:
MCP3xxxas their base class (to avoid confusion) using autodoc's:show-inheritence:directive.AnalogIn's constructor wasn't getting documented because of the odd placement of its__get__magic method before__init__.AnalogIn's constructor to more accurately link to the appropriate objects. See these lines for what I mean.AnalogIn's constructor in both the examples/mcp3xxx_mcp3004_single_ended_simpletest.py and the corresponding copied code in the README.rst files.