Skip to content

correcting_rtype_documentation_sphinx #62

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
May 15, 2021
Merged

correcting_rtype_documentation_sphinx #62

merged 1 commit into from
May 15, 2021

Conversation

jposada202020
Copy link
Contributor

@jposada202020 jposada202020 commented May 15, 2021

well that was a wild ride, not the most elegant solution, but a more standard solution. @lesamouraipourpre now is you turn :) if you could review that would be greatly appreciated 👍🏼

Others Changes:

  1. Removing Busio references
  2. Adding Product ID
  3. Adding product and learning guides to the API
  4. Changing CircuitPython Reference from Github to the Website

Copy link
Contributor

@lesamouraipourpre lesamouraipourpre left a comment

Choose a reason for hiding this comment

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

Documentation built locally and it all looks grand. That's an impressive reworking with all the specific products listed.

I can't believe the solution to the different parameters was as simple as removing the space after the comma. That must have been the only thing I didn't try.
git diff HEAD~2

@@ -620,9 +613,9 @@ class Character_LCD_RGB(Character_LCD):
     :param ~digitalio.DigitalInOut db7: The data line 7
     :param columns: The columns on the charLCD
     :param lines: The lines on the charLCD
-    :param ~pwmio.PWMOut, ~digitalio.DigitalInOut red: Red RGB Anode
-    :param ~pwmio.PWMOut, ~digitalio.DigitalInOut green: Green RGB Anode
-    :param ~pwmio.PWMOut, ~digitalio.DigitalInOut blue: Blue RGB Anode
+    :param ~pwmio.PWMOut,~digitalio.DigitalInOut red: Red RGB Anode
+    :param ~pwmio.PWMOut,~digitalio.DigitalInOut green: Green RGB Anode
+    :param ~pwmio.PWMOut,~digitalio.DigitalInOut blue: Blue RGB Anode
     :param ~digitalio.DigitalInOut read_write: The rw pin. Determines whether to read to or
         write from the display. Not necessary if only writing to the display. Used on shield.

@jposada202020
Copy link
Contributor Author

jposada202020 commented May 15, 2021

Trust me I ve already gave up, I have even installed the Sphinx, rtype.extension (that works, less effectively) but as I mentioned it was wild. A the end when I was cleaning up for submitting by luck I made the mistake of removing the space. Thanks for reviewing. :)

@jposada202020 jposada202020 merged commit 5eb7685 into adafruit:master May 15, 2021
@jposada202020 jposada202020 deleted the correcting_rtype_documentation branch May 15, 2021 15:32
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request May 18, 2021
Updating https://github.com/adafruit/Adafruit_CircuitPython_CharLCD to 3.3.10 from 3.3.9:
  > Merge pull request adafruit/Adafruit_CircuitPython_CharLCD#62 from jposada202020/correcting_rtype_documentation
  > Merge pull request adafruit/Adafruit_CircuitPython_CharLCD#61 from lesamouraipourpre/docs-and-examples
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_HTU21D to 0.11.0 from 0.10.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_HTU21D#16 from jposada202020/adding_temp_rh_resolution

Updating https://github.com/adafruit/Adafruit_CircuitPython_HTU31D to 1.1.0 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_HTU31D#5 from jposada202020/adding_temp_rh_resolution_properties
  > Merge pull request adafruit/Adafruit_CircuitPython_HTU31D#4 from jposada202020/correcting_conversion_formulas
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_MONSTERM4SK to 0.1.3 from 0.1.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_MONSTERM4SK#3 from FoamyGuy/add_jackolantern_example
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_Seesaw to 1.8.2 from 1.8.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_seesaw#66 from jposada202020/examples_api

Updating https://github.com/adafruit/Adafruit_CircuitPython_SHT4x to 1.0.6 from 1.0.5:
  > Merge pull request adafruit/Adafruit_CircuitPython_SHT4x#7 from jposada202020/correcting_print

Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1306 to 2.11.4 from 2.11.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_SSD1306#60 from mrouillard/fix-decimal-separator-issue

Updating https://github.com/adafruit/Adafruit_CircuitPython_FakeRequests to 1.0.3 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_FakeRequests#4 from jposada202020/main
  > "Increase duplicate code check threshold "
  > Merge pull request adafruit/Adafruit_CircuitPython_FakeRequests#3 from FoamyGuy/pylintrc_and_versions

Updating https://github.com/adafruit/Adafruit_CircuitPython_FunHouse to 2.1.1 from 2.1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_FunHouse#14 from makermelissa/main
  > Merge pull request adafruit/Adafruit_CircuitPython_FunHouse#13 from joezilla86/Docstring-updates

Updating https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar to 2.1.1 from 2.1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_ProgressBar#27 from jposada202020/improving_docs
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