diff options
Diffstat (limited to 'docs/userguide')
-rw-r--r-- | docs/userguide/entry_point.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/userguide/entry_point.rst b/docs/userguide/entry_point.rst index 163ce1d9..4aa7f9a2 100644 --- a/docs/userguide/entry_point.rst +++ b/docs/userguide/entry_point.rst @@ -110,7 +110,7 @@ After installing the package, a user may invoke that function by simply calling $ hello-world Hello world -Note that any function configured as a console script, i.e. ``hello_world()`` in +Note that any function used 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 :mod:`argparse` within the body of @@ -183,7 +183,7 @@ Now, running: will open a small application window with the title 'Hello world'. -Note that just as with console scripts, any function configured as a GUI script +Note that just as with console scripts, any function used as a GUI script should not accept any arguments, and any user input can be parsed within the body of the function. GUI scripts also use the same syntax (discussed in the `last section <#entry-points-syntax>`_) for specifying the function to be invoked. |