Skip to content

Improve Ref Docs #10

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 14 commits into from
Mar 5, 2018
Merged

Improve Ref Docs #10

merged 14 commits into from
Mar 5, 2018

Conversation

sommersoft
Copy link
Collaborator

Per Issue #566

No Learn Guides found.

kattni
kattni suggested changes Mar 4, 2018
View reviewed changes
Copy link
Contributor

@kattni kattni 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 doing this! Please resolve the inline reviews. There are two that I don't have suggestions for, and if you can't come up with anything, leave them as they are.

adafruit_max7219/bcddigits.py Outdated
@@ -66,7 +64,8 @@ def init_display(self):

def set_digit(self, dpos, value):
"""
set one digit in the display
Set one digit in the display.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Display one digit."

adafruit_max7219/bcddigits.py Outdated
@@ -78,7 +77,8 @@ def set_digit(self, dpos, value):

def set_digits(self, start, values):
"""
set the display from a list
Set the display from a list.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Display digits from a list."

adafruit_max7219/bcddigits.py Outdated
@@ -89,7 +89,8 @@ def set_digits(self, start, values):

def show_dot(self, dpos, bit_value=None):
"""
set the decimal point for a digit
Set the decimal point for a digit.
Copy link
Contributor

Choose a reason for hiding this comment

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

"The decimal point for a digit."

adafruit_max7219/max7219.py Outdated
@@ -105,21 +113,23 @@ def brightness(self, value):

def show(self):
"""
update the display with recent changes in buffer
Updates the display with recent changes in buffer.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Updates the display."

adafruit_max7219/max7219.py Outdated
"""
for ypos in range(8):
self.write_cmd(_DIGIT0 + ypos, self._buffer[ypos])

def fill(self, bit_value):
"""
set all buffer bits to a col
Sets all buffer bits to a col
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be changed, but I'm not entirely sure what it does, so I'm not entirely sure what to set it to. If you can't think of something reasonable, then leave it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think I know what it's doing, but haven't worked with a MAX7219 before so I can't say for sure. I made it a little more understandable, but still vague. I can put in an issue to have mrmcwethy clear up the docstring, and what it does...

adafruit_max7219/max7219.py
:param bit_value: int value > 0 set the buffer bit, else clears the buffer bit
"""
self.framebuf.fill(bit_value)

def pixel(self, xpos, ypos, bit_value=None):
"""
set one buffer bit
Set one buffer bit
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think I know what it's doing, but haven't worked with a MAX7219 before so I can't say for sure. I made it a little more understandable, but still vague. I can put in an issue to have mrmcwethy clear up the docstring, and what it does...

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good. Thanks!

adafruit_max7219/max7219.py Outdated
@@ -128,11 +138,11 @@ def pixel(self, xpos, ypos, bit_value=None):
self.framebuf.pixel(xpos, ypos, bit_value)

def scroll(self, delta_x, delta_y):
"""scolls the display using delta_x,delta_y"""
"""Scolls the display using delta_x,delta_y."""
Copy link
Contributor

Choose a reason for hiding this comment

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

"Scrolls"

@kattni
Copy link
Contributor

kattni commented Mar 5, 2018

Looks great, thanks!

@kattni kattni merged commit b4d48d8 into adafruit:master Mar 5, 2018
tannewt pushed a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Mar 5, 2018
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@931a805)
b740da5 
Updating https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15 to 0.3.0 from 0.2.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_ADS1x15#9 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_APDS to 1.1.0 from 1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_APDS#4 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_APDS#3 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_BME280 to 2.0.1 from 2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_BME280#6 from sommersoft/new_docs
  > Update README.rst
  > Update README.rst
  > Merge pull request adafruit/Adafruit_CircuitPython_BME280#4 from chickadee-tech/lint
  > Merge pull request adafruit/Adafruit_CircuitPython_BME280#5 from jerryneedell/patch-1
  > Merge pull request adafruit/Adafruit_CircuitPython_BME280#3 from chickadee-tech/lint

Updating https://github.com/adafruit/Adafruit_CircuitPython_BME680 to 3.0.1 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_BME680#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_BMP280 to 3.0.3 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_BMP280#6 from dhalbert/chip_id_error
  > Merge pull request adafruit/Adafruit_CircuitPython_BMP280#5 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_BNO055 to 3.0.2 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_BNO055#7 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_CCS811 to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_CCS811#10 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_CharLCD to 2.2.1 from 2.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_CharLCD#7 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground to 1.2.1 from 1.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_CircuitPlayground#29 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_DHT to 3.0.1 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_DHT#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_DotStar to 1.1.4 from 1.1.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#13 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#12 from mattytrentini/master
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#11 from mrmcwethy/examples
  > Add RTD.yaml and requirements as cookiecutter would generate them.
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#8 from chickadee-tech/master
  > Don't use requirements.txt with RTD
  > Tweak the doc badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_DRV2605 to 0.8.2 from 0.8.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_DRV2605#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_DS1307 to 1.2.1 from 1.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_DS1307#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_DS2413 to 1.0.2 from 1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_DS2413#5 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_DS2413#4 from brentru/fix-autodoc
  > Merge pull request adafruit/Adafruit_CircuitPython_DS2413#3 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_DS3231 to 2.0.4 from 2.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_DS3231#6 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_DS3231#5 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_Fingerp to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_Fingerp#6 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_FXAS21002C to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_FXAS21002C#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700 to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_FXOS8700#6 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_GPS to 3.0.2 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_GPS#3 from cefn/master
  > Merge pull request adafruit/Adafruit_CircuitPython_GPS#2 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_HT16K33 to 2.0.2 from 2.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#5 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_INA219 to 3.0.2 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_INA219#3 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_INA219#2 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_IRRemote to 3.0.2 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_IRRemote#7 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731 to 2.1.2 from 2.1.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_IS31FL3731#9 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH to 4.0.2 from 4.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_LIS3DH#25 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM303 to 1.1.0 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_LSM303#3 from kattni/property-name-update

Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX31855 to 3.0.1 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX31855#5 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX31855#4 from mrmcwethy/examples

Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX7219 to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX7219#10 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX7219#9 from mrmcwethy/addexamples

Updating https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel to 3.2.0 from 3.1.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_NeoPixel#24 from caternuson/master

Updating https://github.com/adafruit/Adafruit_CircuitPython_RFM69 to 1.1.0 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_RFM69#4 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_RFM69#3 from jerryneedell/jerryn_baudrate

Updating https://github.com/adafruit/Adafruit_CircuitPython_SI5351 to 1.0.1 from 1.0.0:
  > Fix enable logic to invert control state.

Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1306 to 2.3.0 from 2.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_SSD1306#10 from mrmcwethy/redmerst
  > Merge pull request adafruit/Adafruit_CircuitPython_SSD1306#9 from raidancampbell/feature/expose_functions

Updating https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing to 0.9.0 from 0.8.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_FeatherWing#3 from kattni/joy-featherwing

Updating https://github.com/adafruit/Adafruit_CircuitPython_RTTTL to 2.0.1 from 2.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_RTTTL#3 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_SimpleIO#27 from brentru/fix-autodoc
  > Merge pull request adafruit/Adafruit_CircuitPython_SimpleIO#25 from brentru/example-codes
  > Merge pull request adafruit/Adafruit_CircuitPython_SimpleIO#26 from inventhouse/inventhouse-servo-patch-1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kattni kattni kattni approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sommersoft @kattni