Skip to content

Commit 232e7c7

Browse files
authored
Merge pull request #1959 from cpforbes/issue1921
Documentation fixes.
2 parents 7ad229e + 09e7f4d commit 232e7c7

File tree

8 files changed

+13
-11
lines changed

8 files changed

+13
-11
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ pseudoxml:
204204
all-source:
205205

206206
locale/circuitpython.pot: all-source
207-
find $(TRANSLATE_SOURCES) -iname "*.c" -print0 | sort -z | xargs -0 xgettext -L C -s --add-location=file --keyword=translate -o circuitpython.pot -p locale
207+
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
208208

209209
translate: locale/circuitpython.pot
210210
for po in $(shell ls locale/*.po); do msgmerge -U $$po -s --no-fuzzy-matching --add-location=file locale/circuitpython.pot; done

docs/library/builtins.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Exceptions
182182

183183
.. exception:: OSError
184184

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

@@ -198,11 +198,11 @@ Exceptions
198198

199199
.. exception:: SystemExit
200200

201-
|see_cpython| :py:class:`python:SystemExit`.
201+
|see_cpython| :py:class:`cpython:SystemExit`.
202202

203203
.. exception:: TypeError
204204

205-
|see_cpython| :py:class:`python:TypeError`.
205+
|see_cpython| :py:class:`cpython:TypeError`.
206206

207207
.. exception:: ValueError
208208

shared-bindings/digitalio/DigitalInOut.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949
//| =========================================================
5050
//|
5151
//| A DigitalInOut is used to digitally control I/O pins. For analog control of
52-
//| a pin, see the :py:class:`~digitalio.AnalogIn` and
53-
//| :py:class:`~digitalio.AnalogOut` classes.
52+
//| a pin, see the :py:class:`analogio.AnalogIn` and
53+
//| :py:class:`analogio.AnalogOut` classes.
5454
//|
5555

5656
//| .. class:: DigitalInOut(pin)

shared-bindings/digitalio/Direction.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
//| :class:`Direction` -- defines the direction of a digital pin
4444
//| =============================================================
4545
//|
46-
//| .. class:: digitalio.DigitalInOut.Direction
46+
//| .. class:: Direction
4747
//|
4848
//| Enum-like class to define which direction the digital values are
4949
//| going.

shared-bindings/digitalio/DriveMode.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
//| :class:`DriveMode` -- defines the drive mode of a digital pin
3232
//| =============================================================
3333
//|
34-
//| .. class:: digitalio.DriveMode
34+
//| .. class:: DriveMode
3535
//|
3636
//| Enum-like class to define the drive mode used when outputting
3737
//| digital values.

shared-bindings/digitalio/Pull.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
//| :class:`Pull` -- defines the pull of a digital input pin
3232
//| =============================================================
3333
//|
34-
//| .. class:: digitalio.Pull
34+
//| .. class:: Pull
3535
//|
3636
//| Enum-like class to define the pull value, if any, used while reading
3737
//| digital values in.

shared-bindings/displayio/Display.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@
7878
//| The initialization sequence should always leave the display memory access inline with the scan
7979
//| of the display to minimize tearing artifacts.
8080
//|
81-
//| :param displayio.FourWire or displayio.ParallelBus display_bus: The bus that the display is connected to
81+
//| :param display_bus: The bus that the display is connected to
82+
//| :type display_bus: displayio.FourWire or displayio.ParallelBus
8283
//| :param buffer init_sequence: Byte-packed initialization sequence.
8384
//| :param int width: Width in pixels
8485
//| :param int height: Height in pixels
@@ -182,6 +183,7 @@ static displayio_display_obj_t* native_display(mp_obj_t display_obj) {
182183
//| Switches to displaying the given group of layers. When group is None, the default
183184
//| CircuitPython terminal will be shown.
184185
//|
186+
//| :param Group group: The group to show.
185187
STATIC mp_obj_t displayio_display_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
186188
displayio_display_obj_t *self = native_display(self_in);
187189
displayio_group_t* group = NULL;

shared-bindings/fontio/Glyph.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
//|
3838
//| Named tuple used to capture a single glyph and its attributes.
3939
//|
40-
//| :param fontio.Bitmap bitmap: the bitmap including the glyph
40+
//| :param displayio.Bitmap bitmap: the bitmap including the glyph
4141
//| :param int tile_index: the tile index within the bitmap
4242
//| :param int width: the width of the glyph's bitmap
4343
//| :param int height: the height of the glyph's bitmap

0 commit comments

Comments
 (0)