Merge pull request #6341 from tekktrik/doc/add-time-module-link

Link to CPython docs for subset modules

Author: dhalbert

shared-bindings/atexit/__init__.c

@@ -34,6 +34,7 @@
 //| These functions are run in the reverse order in which they were registered;
 //| if you register ``A``, ``B``, and ``C``, they will be run in the order ``C``, ``B``, ``A``.
 //|
+//| |see_cpython_module| :mod:`cpython:atexit`.
 //| """
 //| ...
 //|

shared-bindings/math/__init__.c

@@ -41,7 +41,10 @@
 //| """mathematical functions
 //|
 //| The `math` module provides some basic mathematical functions for
-//| working with floating-point numbers."""
+//| working with floating-point numbers.
+//|
+//| |see_cpython_module| :mod:`cpython:math`.
+//| """
 //|
 
 STATIC NORETURN void math_error(void) {

shared-bindings/os/__init__.c

@@ -39,9 +39,8 @@
 
 //| """functions that an OS normally provides
 //|
-//| The `os` module is a strict subset of the CPython `cpython:os` module. So,
-//| code written in CircuitPython will work in CPython but not necessarily the
-//| other way around."""
+//| |see_cpython_module| :mod:`cpython:os`.
+//| """
 //|
 //| import typing
 

shared-bindings/random/__init__.c

@@ -35,9 +35,7 @@
 
 //| """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.

shared-bindings/socketpool/__init__.c

@@ -35,6 +35,9 @@
 //| """
 //| The `socketpool` module provides sockets through a pool. The pools themselves
 //| act like CPython's `socket` module.
+//|
+//| For more information about the `socket` module, see the CPython documentation:
+//| https://docs.python.org/3/library/socket.html
 //| """
 //|
 

shared-bindings/ssl/__init__.c

@@ -33,6 +33,8 @@
 
 //| """
 //| The `ssl` module provides SSL contexts to wrap sockets in.
+//|
+//| |see_cpython_module| :mod:`cpython:ssl`.
 //| """
 //|
 

shared-bindings/struct/__init__.c

@@ -40,9 +40,7 @@
 
 //| """Manipulation of c-style data
 //|
-//| This module implements a subset of the corresponding CPython module,
-//| as described below. For more information, refer to the original CPython
-//| documentation: struct.
+//| |see_cpython_module| :mod:`cpython:struct`.
 //|
 //| Supported size/byte order prefixes: *@*, *<*, *>*, *!*.
 //|

shared-bindings/time/__init__.c

@@ -38,9 +38,8 @@
 
 //| """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."""
+//| |see_cpython_module| :mod:`cpython:time`.
+//| """
 //|
 //| def monotonic() -> float:
 //|     """Returns an always increasing value of time with an unknown reference

shared-bindings/traceback/__init__.c

@@ -34,6 +34,7 @@
 //| This module provides a standard interface to print stack traces of programs.
 //| This is useful when you want to print stack traces under program control.
 //|
+//| |see_cpython_module| :mod:`cpython:traceback`.
 //| """
 //| ...
 //|