Use shortcut "directive" for subset note

This commit is contained in:
Alec Delaney 2022-05-03 14:56:12 -04:00
parent bbc29e84a7
commit 24fb138311
3 changed files with 4 additions and 20 deletions

View File

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

View File

@ -34,12 +34,7 @@
//| """
//| The `ssl` module provides SSL contexts to wrap sockets in.
//|
//| This module is a strict subset of the CPython `ssl` module.
//| So, code written in CircuitPython will work in CPython but not
//| necessarily the other way around.
//|
//| For more information about the `ssl` module see the CPython documentation
//| https://docs.python.org/3/library/ssl.html
//| |see_cpython_module| :mod:`cpython:ssl`.
//| """
//|

View File

@ -38,12 +38,7 @@
//| """time and timing related functions
//|
//| The `time` module is a strict subset of the CPython `cpython:time` module. So, code
//| using `time` written in CircuitPython will work in CPython but not necessarily the other
//| way around.
//|
//| For more information about the `time` module, see the CPython documentation:
//| https://docs.python.org/3/library/time.html
//| |see_cpython_module| :mod:`cpython:time`.
//| """
//|
//| def monotonic() -> float: