Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

misleading docstr in DigitalInOut.pull

See original GitHub issue

https://github.com/adafruit/Adafruit_Blinka/blob/4f4e6af0a2c2912d7662f0160849806507b125bd/src/digitalio.py#L190-L191

I think this docstr should say

"""Get or set the Digital Pin's input impedance."""

ps - I think this is simply a copy-n-paste mistake.

Issue Analytics

State:
Created 2 years ago
Comments:5 (4 by maintainers)

Top GitHub Comments

1reaction

tannewtcommented, Aug 2, 2021

Property documentation shouldn’t say get or set that is implied. The CircuitPython doc string for this is The pin pull direction. https://github.com/adafruit/circuitpython/blob/main/shared-bindings/digitalio/DigitalInOut.c#L306

0reactions

makermelissacommented, Aug 2, 2021

Oh I see, I’ve probably made that mistake in other libraries myself.

Top Results From Across the Web

CircuitPython Digital In & Out - Adafruit Learning System

This example shows how to use both a digital input and output. You can use a switch input with pullup resistor (built in)...

Source code for adafruit_seesaw.digitalio - CircuitPython

Source code for adafruit_seesaw.digitalio ... Built with Sphinx using a theme provided by Read the Docs. Read the Docs v: latest.

pandas docstring guide — pandas 1.5.2 documentation

A Python docstring is a string used to document a Python module, class, function or method, so programmers can understand what it does...

Python Docstrings Tutorial : Examples & Format for Pydoc ...

See Python Docstrings. Learn about the different types of docstrings & various docstring formats like Sphinx, Numpy, and Pydoc with examples now.

doctest — Test interactive Python examples — Python 3.11.1 ...

The module docstring, and all function, class and method docstrings are searched. ... doctest.run_docstring_examples(f, globs, verbose=False, name='NoName', ...