diff options
| author | Saniya Maheshwari <55744224+codeandfire@users.noreply.github.com> | 2022-06-12 15:23:51 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-12 15:23:51 +0530 |
| commit | 8ff959675e9ea519febb61de477f047302170d94 (patch) | |
| tree | 74cb46df753b8972e4f6f08f1be9dd6cb0f4fa25 /docs/userguide | |
| parent | 7224c3d9f57babc43b415d40259ec42754fe65e3 (diff) | |
| download | python-setuptools-git-8ff959675e9ea519febb61de477f047302170d94.tar.gz | |
Apply suggestions from code review
Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/entry_point.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/userguide/entry_point.rst b/docs/userguide/entry_point.rst index cc44aa38..28ae3dfe 100644 --- a/docs/userguide/entry_point.rst +++ b/docs/userguide/entry_point.rst @@ -4,8 +4,9 @@ Entry Points ============ -Entry points are a very useful feature of Python packages. -They come in use in two scenarios: +Entry points are a type of metadata that can be exposed by packages on installation. +They are a very useful feature of the Python ecosystem, +and come specially handy in two scenarios: 1. The package would like to provide commands to be run at the terminal. This functionality is known as *console* scripts. The command may also @@ -110,7 +111,7 @@ After installing the package, a user may invoke that function by simply calling Note that any function configured as a console script, i.e. ``hello_world()`` in this example, should not accept any arguments. If your function requires any input from the user, you can use regular command-line argument parsing utilities like -`argparse <https://docs.python.org/3/library/argparse.html>`_ within the body of +:mod:`argparse` within the body of the function to parse user input given via :obj:`sys.argv`. You may have noticed that we have used a special syntax to specify the function |