diff options
| author | Saniya Maheshwari <saniya.mah@gmail.com> | 2022-06-08 21:49:48 +0530 |
|---|---|---|
| committer | Saniya Maheshwari <saniya.mah@gmail.com> | 2022-06-08 22:26:10 +0530 |
| commit | 8aa6700215bbb1394fa8c5e6aef41c4a16ee4f04 (patch) | |
| tree | 9409a80d51d5c64ec40edc44b021d4ef8fdc2864 /docs/userguide/entry_point.rst | |
| parent | a6180e85d58f7fc1674728c63a53939586247caa (diff) | |
| download | python-setuptools-git-8aa6700215bbb1394fa8c5e6aef41c4a16ee4f04.tar.gz | |
Illustrate input/output with/without console scripts
- Added output of the command `python -m timmins`.
- Added input and output when a console script is set up, i.e. when
`hello-world` is run on the terminal.
Diffstat (limited to 'docs/userguide/entry_point.rst')
| -rw-r--r-- | docs/userguide/entry_point.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/userguide/entry_point.rst b/docs/userguide/entry_point.rst index 28bdc3ad..e39ae5c8 100644 --- a/docs/userguide/entry_point.rst +++ b/docs/userguide/entry_point.rst @@ -45,7 +45,8 @@ After installing the package, the function may be invoked through the .. code-block:: bash - python -m timmins + $ python -m timmins + Hello world Adding a console script entry point allows the package to define a user-friendly name for installers of the package to execute. Installers @@ -86,7 +87,12 @@ your configuration: After installing the package, a user may invoke that function by simply calling -``hello-world`` on the command line. +``hello-world`` on the command line: + +.. code-block:: bash + + $ hello-world + Hello world The syntax for entry points is specified as follows: |