diff --git a/Doc/library/constants.rst b/Doc/library/constants.rst index d058ba206c6cd6..45f111ef4acbc7 100644 --- a/Doc/library/constants.rst +++ b/Doc/library/constants.rst @@ -112,12 +112,14 @@ should not be used in programs. .. data:: copyright credits + :noindex: Objects that when printed or called, print the text of copyright or - credits, respectively. + credits, respectively (see :func:`copyright` and :func:`credits`). .. data:: license + :noindex: Object that when printed, prints the message "Type license() to see the full license text", and when called, displays the full license text in a - pager-like fashion (one screen at a time). + pager-like fashion (see :func:`license`). diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 61799e303a1639..a3cd7a433090f8 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -12,32 +12,33 @@ are always available. They are listed here in alphabetical order. +=========================+=======================+=======================+=========================+ | | **A** | | **E** | | **L** | | **R** | | | :func:`abs` | | :func:`enumerate` | | :func:`len` | | |func-range|_ | -| | :func:`aiter` | | :func:`eval` | | |func-list|_ | | :func:`repr` | -| | :func:`all` | | :func:`exec` | | :func:`locals` | | :func:`reversed` | -| | :func:`anext` | | | | | | :func:`round` | -| | :func:`any` | | **F** | | **M** | | | -| | :func:`ascii` | | :func:`filter` | | :func:`map` | | **S** | -| | | | :func:`float` | | :func:`max` | | |func-set|_ | -| | **B** | | :func:`format` | | |func-memoryview|_ | | :func:`setattr` | -| | :func:`bin` | | |func-frozenset|_ | | :func:`min` | | :func:`slice` | -| | :func:`bool` | | | | | | :func:`sorted` | -| | :func:`breakpoint` | | **G** | | **N** | | :func:`staticmethod` | -| | |func-bytearray|_ | | :func:`getattr` | | :func:`next` | | |func-str|_ | -| | |func-bytes|_ | | :func:`globals` | | | | :func:`sum` | -| | | | | | **O** | | :func:`super` | -| | **C** | | **H** | | :func:`object` | | | -| | :func:`callable` | | :func:`hasattr` | | :func:`oct` | | **T** | -| | :func:`chr` | | :func:`hash` | | :func:`open` | | |func-tuple|_ | -| | :func:`classmethod` | | :func:`help` | | :func:`ord` | | :func:`type` | -| | :func:`compile` | | :func:`hex` | | | | | -| | :func:`complex` | | | | **P** | | **V** | -| | | | **I** | | :func:`pow` | | :func:`vars` | -| | **D** | | :func:`id` | | :func:`print` | | | -| | :func:`delattr` | | :func:`input` | | :func:`property` | | **Z** | -| | |func-dict|_ | | :func:`int` | | | | :func:`zip` | -| | :func:`dir` | | :func:`isinstance` | | | | | -| | :func:`divmod` | | :func:`issubclass` | | | | **_** | -| | | | :func:`iter` | | | | :func:`__import__` | +| | :func:`aiter` | | :func:`eval` | | :func:`license` | | :func:`repr` | +| | :func:`all` | | :func:`exec` | | |func-list|_ | | :func:`reversed` | +| | :func:`anext` | | | | :func:`locals` | | :func:`round` | +| | :func:`any` | | **F** | | | | | +| | :func:`ascii` | | :func:`filter` | | **M** | | **S** | +| | | | :func:`float` | | :func:`map` | | |func-set|_ | +| | **B** | | :func:`format` | | :func:`max` | | :func:`setattr` | +| | :func:`bin` | | |func-frozenset|_ | | |func-memoryview|_ | | :func:`slice` | +| | :func:`bool` | | | | :func:`min` | | :func:`sorted` | +| | :func:`breakpoint` | | **G** | | | | :func:`staticmethod` | +| | |func-bytearray|_ | | :func:`getattr` | | **N** | | |func-str|_ | +| | |func-bytes|_ | | :func:`globals` | | :func:`next` | | :func:`sum` | +| | | | | | | | :func:`super` | +| | **C** | | **H** | | **O** | | | +| | :func:`callable` | | :func:`hasattr` | | :func:`object` | | **T** | +| | :func:`chr` | | :func:`hash` | | :func:`oct` | | |func-tuple|_ | +| | :func:`classmethod` | | :func:`help` | | :func:`open` | | :func:`type` | +| | :func:`compile` | | :func:`hex` | | :func:`ord` | | | +| | :func:`complex` | | | | | | **V** | +| | :func:`copyright` | | **I** | | **P** | | :func:`vars` | +| | :func:`credits` | | :func:`id` | | :func:`pow` | | | +| | | | :func:`input` | | :func:`print` | | **Z** | +| | **D** | | :func:`int` | | :func:`property` | | :func:`zip` | +| | :func:`delattr` | | :func:`isinstance` | | | | | +| | |func-dict|_ | | :func:`issubclass` | | | | **_** | +| | :func:`dir` | | :func:`iter` | | | | :func:`__import__` | +| | :func:`divmod` | | | | | | | +-------------------------+-----------------------+-----------------------+-------------------------+ .. using :func:`dict` would create a link to another page, so local targets are @@ -456,6 +457,20 @@ are always available. They are listed here in alphabetical order. deprecated; it should only be passed as a single positional argument. +.. function:: copyright() + + Print the full :data:`copyright` text. + + This function is added to the built-in namespace by the :mod:`site` module. + + +.. function:: credits() + + Print the full :data:`credits` text. + + This function is added to the built-in namespace by the :mod:`site` module. + + .. function:: delattr(object, name, /) This is a relative of :func:`setattr`. The arguments are an object and a @@ -1141,6 +1156,14 @@ are always available. They are listed here in alphabetical order. :data:`sys.maxsize`, such as :class:`range(2 ** 100) `. +.. function:: license() + + Displays the full license text in a pager-like fashion (one page at a time; + this function is intended for interactive use). + + This function is added to the built-in namespace by the :mod:`site` module. + + .. _func-list: .. class:: list(iterable=(), /) :noindex: