Skip to content

Commit 24fb138

Browse files
committed
Use shortcut "directive" for subset note
1 parent bbc29e8 commit 24fb138

File tree

3 files changed

+4
-20
lines changed

3 files changed

+4
-20
lines changed

shared-bindings/random/__init__.c

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,14 @@
3535

3636
//| """pseudo-random numbers and choices
3737
//|
38-
//| The `random` module is a strict subset of the CPython `cpython:random`
39-
//| module. So, code written in CircuitPython will work in CPython but not
40-
//| necessarily the other way around.
38+
//| |see_cpython_module| :mod:`cpython:random`.
4139
//|
4240
//| Like its CPython cousin, CircuitPython's random seeds itself on first use
4341
//| with a true random from os.urandom() when available or the uptime otherwise.
4442
//| Once seeded, it will be deterministic, which is why its bad for cryptography.
4543
//|
4644
//| .. warning:: Numbers from this module are not cryptographically strong! Use
47-
//| bytes from `os.urandom` directly for true randomness.
48-
//|
49-
//| For more information about the `random` module, see the CPython documentation:
50-
//| https://docs.python.org/3/library/random.html
51-
//| """
45+
//| bytes from `os.urandom` directly for true randomness."""
5246
//|
5347
//| from typing import TypeVar
5448
//| _T = TypeVar('_T')

shared-bindings/ssl/__init__.c

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,7 @@
3434
//| """
3535
//| The `ssl` module provides SSL contexts to wrap sockets in.
3636
//|
37-
//| This module is a strict subset of the CPython `ssl` module.
38-
//| So, code written in CircuitPython will work in CPython but not
39-
//| necessarily the other way around.
40-
//|
41-
//| For more information about the `ssl` module see the CPython documentation
42-
//| https://docs.python.org/3/library/ssl.html
37+
//| |see_cpython_module| :mod:`cpython:ssl`.
4338
//| """
4439
//|
4540

shared-bindings/time/__init__.c

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,7 @@
3838

3939
//| """time and timing related functions
4040
//|
41-
//| The `time` module is a strict subset of the CPython `cpython:time` module. So, code
42-
//| using `time` written in CircuitPython will work in CPython but not necessarily the other
43-
//| way around.
44-
//|
45-
//| For more information about the `time` module, see the CPython documentation:
46-
//| https://docs.python.org/3/library/time.html
41+
//| |see_cpython_module| :mod:`cpython:time`.
4742
//| """
4843
//|
4944
//| def monotonic() -> float:

0 commit comments

Comments
 (0)