Skip to content

C
cpython
Commit 3f5e958a authored by Éric Araujo's avatar Éric Araujo
Browse files
Options

Fix type information in distutils API reference (#9302). 

Initial patch by Yue Shuaijie.
parent cc42ebe4
Show whitespace changes
Inline Side-by-side
Showing with 29 additions and 28 deletions
Doc/ACKS.txt
View file @ 3f5e958a
...@@ -188,6 +188,7 @@ docs@python.org), and we'll be glad to correct the problem. ...@@ -188,6 +188,7 @@ docs@python.org), and we'll be glad to correct the problem.
* Joakim Sernbrant * Joakim Sernbrant
* Justin Sheehy * Justin Sheehy
* Charlie Shepherd * Charlie Shepherd
* Yue Shuaijie
* SilentGhost * SilentGhost
* Michael Simcich * Michael Simcich
* Ionel Simionescu * Ionel Simionescu
......
Doc/distutils/apiref.rst
View file @ 3f5e958a
...@@ -31,8 +31,9 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and ...@@ -31,8 +31,9 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
+====================+================================+=============================================================+ +====================+================================+=============================================================+
| *name* | The name of the package | a string | | *name* | The name of the package | a string |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *version* | The version number of the | See :mod:`distutils.version` | | *version* | The version number of the | a string |
| | package | | | | package; see | |
| | :mod:`distutils.version` | |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *description* | A single line describing the | a string | | *description* | A single line describing the | a string |
| | package | | | | package | |
...@@ -49,14 +50,14 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and ...@@ -49,14 +50,14 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
| | maintainer, if different from | | | | maintainer, if different from | |
| | the author | | | | the author | |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *maintainer_email* | The email address of the | | | *maintainer_email* | The email address of the | a string |
| | current maintainer, if | | | | current maintainer, if | |
| | different from the author | | | | different from the author | |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *url* | A URL for the package | a URL | | *url* | A URL for the package | a string |
| | (homepage) | | | | (homepage) | |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *download_url* | A URL to download the package | a URL | | *download_url* | A URL to download the package | a string |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *packages* | A list of Python packages that | a list of strings | | *packages* | A list of Python packages that | a list of strings |
| | distutils will manipulate | | | | distutils will manipulate | |
...@@ -68,14 +69,13 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and ...@@ -68,14 +69,13 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
| | files to be built and | | | | files to be built and | |
| | installed | | | | installed | |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *ext_modules* | A list of Python extensions to | A list of instances of | | *ext_modules* | A list of Python extensions to | a list of instances of |
| | be built | :class:`distutils.core.Extension` | | | be built | :class:`distutils.core.Extension` |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *classifiers* | A list of categories for the | The list of available | | *classifiers* | A list of categories for the | a list of strings; valid classifiers are listed on `PyPI |
| | package | categorizations is available on `PyPI | | | package | <http://pypi.python.org/pypi?:action=list_classifiers>`_. |
| | | <http://pypi.python.org/pypi?:action=list_classifiers>`_. |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *distclass* | the :class:`Distribution` | A subclass of | | *distclass* | the :class:`Distribution` | a subclass of |
| | class to use | :class:`distutils.core.Distribution` | | | class to use | :class:`distutils.core.Distribution` |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *script_name* | The name of the setup.py | a string | | *script_name* | The name of the setup.py | a string |
...@@ -85,15 +85,15 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and ...@@ -85,15 +85,15 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
| *script_args* | Arguments to supply to the | a list of strings | | *script_args* | Arguments to supply to the | a list of strings |
| | setup script | | | | setup script | |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *options* | default options for the setup | a string | | *options* | default options for the setup | a dictionary |
| | script | | | | script | |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *license* | The license for the package | a string | | *license* | The license for the package | a string |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *keywords* | Descriptive meta-data, see | | | *keywords* | Descriptive meta-data, see | a list of strings or a comma-separated string |
| | :pep:`314` | | | | :pep:`314` | |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *platforms* | | | | *platforms* | | a list of strings or a comma-separated string |
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *cmdclass* | A mapping of command names to | a dictionary | | *cmdclass* | A mapping of command names to | a dictionary |
| | :class:`Command` subclasses | | | | :class:`Command` subclasses | |
...@@ -165,13 +165,13 @@ the full reference. ...@@ -165,13 +165,13 @@ the full reference.
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| argument name | value | type | | argument name | value | type |
+========================+================================+===========================+ +========================+================================+===========================+
| *name* | the full name of the | string | | *name* | the full name of the | a string |
| | extension, including any | | | | extension, including any | |
| | packages --- ie. *not* a | | | | packages --- ie. *not* a | |
| | filename or pathname, but | | | | filename or pathname, but | |
| | Python dotted name | | | | Python dotted name | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *sources* | list of source filenames, | string | | *sources* | list of source filenames, | a list of strings |
| | relative to the distribution | | | | relative to the distribution | |
| | root (where the setup script | | | | root (where the setup script | |
| | lives), in Unix form (slash- | | | | lives), in Unix form (slash- | |
...@@ -184,12 +184,12 @@ the full reference. ...@@ -184,12 +184,12 @@ the full reference.
| | as source for a Python | | | | as source for a Python | |
| | extension. | | | | extension. | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *include_dirs* | list of directories to search | string | | *include_dirs* | list of directories to search | a list of strings |
| | for C/C++ header files (in | | | | for C/C++ header files (in | |
| | Unix form for portability) | | | | Unix form for portability) | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *define_macros* | list of macros to define; each | (string, string) tuple or | | *define_macros* | list of macros to define; each | a list of tuples |
| | macro is defined using a | (name, ``None``) | | | macro is defined using a | |
| | 2-tuple ``(name, value)``, | | | | 2-tuple ``(name, value)``, | |
| | where *value* is | | | | where *value* is | |
| | either the string to define it | | | | either the string to define it | |
...@@ -200,31 +200,31 @@ the full reference. ...@@ -200,31 +200,31 @@ the full reference.
| | on Unix C compiler command | | | | on Unix C compiler command | |
| | line) | | | | line) | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *undef_macros* | list of macros to undefine | string | | *undef_macros* | list of macros to undefine | a list of strings |
| | explicitly | | | | explicitly | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *library_dirs* | list of directories to search | string | | *library_dirs* | list of directories to search | a list of strings |
| | for C/C++ libraries at link | | | | for C/C++ libraries at link | |
| | time | | | | time | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *libraries* | list of library names (not | string | | *libraries* | list of library names (not | a list of strings |
| | filenames or paths) to link | | | | filenames or paths) to link | |
| | against | | | | against | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *runtime_library_dirs* | list of directories to search | string | | *runtime_library_dirs* | list of directories to search | a list of strings |
| | for C/C++ libraries at run | | | | for C/C++ libraries at run | |
| | time (for shared extensions, | | | | time (for shared extensions, | |
| | this is when the extension is | | | | this is when the extension is | |
| | loaded) | | | | loaded) | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *extra_objects* | list of extra files to link | string | | *extra_objects* | list of extra files to link | a list of strings |
| | with (eg. object files not | | | | with (eg. object files not | |
| | implied by 'sources', static | | | | implied by 'sources', static | |
| | library that must be | | | | library that must be | |
| | explicitly specified, binary | | | | explicitly specified, binary | |
| | resource files, etc.) | | | | resource files, etc.) | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *extra_compile_args* | any extra platform- and | string | | *extra_compile_args* | any extra platform- and | a list of strings |
| | compiler-specific information | | | | compiler-specific information | |
| | to use when compiling the | | | | to use when compiling the | |
| | source files in 'sources'. For | | | | source files in 'sources'. For | |
...@@ -235,7 +235,7 @@ the full reference. ...@@ -235,7 +235,7 @@ the full reference.
| | for other platforms it could | | | | for other platforms it could | |
| | be anything. | | | | be anything. | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *extra_link_args* | any extra platform- and | string | | *extra_link_args* | any extra platform- and | a list of strings |
| | compiler-specific information | | | | compiler-specific information | |
| | to use when linking object | | | | to use when linking object | |
| | files together to create the | | | | files together to create the | |
...@@ -244,7 +244,7 @@ the full reference. ...@@ -244,7 +244,7 @@ the full reference.
| | Similar interpretation as for | | | | Similar interpretation as for | |
| | 'extra_compile_args'. | | | | 'extra_compile_args'. | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *export_symbols* | list of symbols to be exported | string | | *export_symbols* | list of symbols to be exported | a list of strings |
| | from a shared extension. Not | | | | from a shared extension. Not | |
| | used on all platforms, and not | | | | used on all platforms, and not | |
| | generally necessary for Python | | | | generally necessary for Python | |
...@@ -252,10 +252,10 @@ the full reference. ...@@ -252,10 +252,10 @@ the full reference.
| | export exactly one symbol: | | | | export exactly one symbol: | |
| | ``init`` + extension_name. | | | | ``init`` + extension_name. | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *depends* | list of files that the | string | | *depends* | list of files that the | a list of strings |
| | extension depends on | | | | extension depends on | |
+------------------------+--------------------------------+---------------------------+ +------------------------+--------------------------------+---------------------------+
| *language* | extension language (i.e. | string | | *language* | extension language (i.e. | a string |
| | ``'c'``, ``'c++'``, | | | | ``'c'``, ``'c++'``, | |
| | ``'objc'``). Will be detected | | | | ``'objc'``). Will be detected | |
| | from the source extensions if | | | | from the source extensions if | |
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7