Skip to content

Documentation fixes. #1959

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 5 commits into from
Jun 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ pseudoxml:
all-source:

locale/circuitpython.pot: all-source
find $(TRANSLATE_SOURCES) -iname "*.c" -print0 | sort -z | xargs -0 xgettext -L C -s --add-location=file --keyword=translate -o circuitpython.pot -p locale
find $(TRANSLATE_SOURCES) -iname "*.c" -print0 | (LC_ALL=C sort -z) | xargs -0 xgettext -L C -s --add-location=file --keyword=translate -o circuitpython.pot -p locale

translate: locale/circuitpython.pot
for po in $(shell ls locale/*.po); do msgmerge -U $$po -s --no-fuzzy-matching --add-location=file locale/circuitpython.pot; done
Expand Down
6 changes: 3 additions & 3 deletions docs/library/builtins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ Exceptions

.. exception:: OSError

|see_cpython| `OSError`. CircuitPython doesn't implement the ``errno``
|see_cpython| :py:class:`cpython:OSError`. CircuitPython doesn't implement the ``errno``
attribute, instead use the standard way to access exception arguments:
``exc.args[0]``.

Expand All @@ -198,11 +198,11 @@ Exceptions

.. exception:: SystemExit

|see_cpython| :py:class:`python:SystemExit`.
|see_cpython| :py:class:`cpython:SystemExit`.

.. exception:: TypeError

|see_cpython| :py:class:`python:TypeError`.
|see_cpython| :py:class:`cpython:TypeError`.

.. exception:: ValueError

Expand Down
4 changes: 2 additions & 2 deletions shared-bindings/digitalio/DigitalInOut.c
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@
//| =========================================================
//|
//| A DigitalInOut is used to digitally control I/O pins. For analog control of
//| a pin, see the :py:class:`~digitalio.AnalogIn` and
//| :py:class:`~digitalio.AnalogOut` classes.
//| a pin, see the :py:class:`analogio.AnalogIn` and
//| :py:class:`analogio.AnalogOut` classes.
//|

//| .. class:: DigitalInOut(pin)
Expand Down
2 changes: 1 addition & 1 deletion shared-bindings/digitalio/Direction.c
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
//| :class:`Direction` -- defines the direction of a digital pin
//| =============================================================
//|
//| .. class:: digitalio.DigitalInOut.Direction
//| .. class:: Direction
//|
//| Enum-like class to define which direction the digital values are
//| going.
Expand Down
2 changes: 1 addition & 1 deletion shared-bindings/digitalio/DriveMode.c
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//| :class:`DriveMode` -- defines the drive mode of a digital pin
//| =============================================================
//|
//| .. class:: digitalio.DriveMode
//| .. class:: DriveMode
//|
//| Enum-like class to define the drive mode used when outputting
//| digital values.
Expand Down
2 changes: 1 addition & 1 deletion shared-bindings/digitalio/Pull.c
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//| :class:`Pull` -- defines the pull of a digital input pin
//| =============================================================
//|
//| .. class:: digitalio.Pull
//| .. class:: Pull
//|
//| Enum-like class to define the pull value, if any, used while reading
//| digital values in.
Expand Down
4 changes: 3 additions & 1 deletion shared-bindings/displayio/Display.c
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@
//| The initialization sequence should always leave the display memory access inline with the scan
//| of the display to minimize tearing artifacts.
//|
//| :param displayio.FourWire or displayio.ParallelBus display_bus: The bus that the display is connected to
//| :param display_bus: The bus that the display is connected to
//| :type display_bus: displayio.FourWire or displayio.ParallelBus
//| :param buffer init_sequence: Byte-packed initialization sequence.
//| :param int width: Width in pixels
//| :param int height: Height in pixels
Expand Down Expand Up @@ -182,6 +183,7 @@ static displayio_display_obj_t* native_display(mp_obj_t display_obj) {
//| Switches to displaying the given group of layers. When group is None, the default
//| CircuitPython terminal will be shown.
//|
//| :param Group group: The group to show.
STATIC mp_obj_t displayio_display_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
displayio_display_obj_t *self = native_display(self_in);
displayio_group_t* group = NULL;
Expand Down
2 changes: 1 addition & 1 deletion shared-bindings/fontio/Glyph.c
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
//|
//| Named tuple used to capture a single glyph and its attributes.
//|
//| :param fontio.Bitmap bitmap: the bitmap including the glyph
//| :param displayio.Bitmap bitmap: the bitmap including the glyph
//| :param int tile_index: the tile index within the bitmap
//| :param int width: the width of the glyph's bitmap
//| :param int height: the height of the glyph's bitmap
Expand Down