]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
#652749: document the constants added to the builtins by site.py.
authorGeorg Brandl <georg@python.org>
Sun, 20 Jan 2008 13:08:37 +0000 (13:08 +0000)
committerGeorg Brandl <georg@python.org>
Sun, 20 Jan 2008 13:08:37 +0000 (13:08 +0000)
Doc/library/constants.rst
Doc/library/functions.rst

index 7e6397824c5de5a3a602e6003f79ee7afc87fabe..222bc408faf60ff89eb3bf38ea39e01577de3dbf 100644 (file)
@@ -1,4 +1,3 @@
-
 Built-in Constants
 ==================
 
@@ -47,4 +46,28 @@ A small number of constants live in the built-in namespace.  They are:
 
    This constant is true if Python was not started with an :option:`-O` option.
    Assignments to :const:`__debug__` are illegal and raise a :exc:`SyntaxError`.
-   See also the :keyword:`assert` statement.
\ No newline at end of file
+   See also the :keyword:`assert` statement.
+
+
+Constants added by the :mod:`site` module
+-----------------------------------------
+
+The :mod:`site` module (which is imported automatically during startup, except
+if the :option:`-S` command-line option is given) adds several constants to the
+built-in namespace.  They are useful for the interactive interpreter shell and
+should not be used in programs.
+
+.. data:: quit([code=None])
+          exit([code=None])
+
+   Objects that when printed, print a message like "Use quit() or Ctrl-D
+   (i.e. EOF) to exit", and when called, raise :exc:`SystemExit` with the
+   specified exit code, and when .
+
+.. data:: copyright
+          license
+          credits
+
+   Objects that when printed, print a message like "Type license() to see the
+   full license text", and when called, display the corresponding text in a
+   pager-like fashion (one screen at a time).
index 665b8657124b887bf37070f807103d1dd0b3b519..227b0fcc5486dde7ccae5036acedf2949b1b6311 100644 (file)
@@ -511,6 +511,8 @@ available.  They are listed here in alphabetical order.
    topic, and a help page is printed on the console.  If the argument is any other
    kind of object, a help page on the object is generated.
 
+   This function is added to the built-in namespace by the :mod:`site` module.
+
    .. versionadded:: 2.2