diff --git a/source/guides/writing-pyproject-toml.rst b/source/guides/writing-pyproject-toml.rst index 92a7f25bf..34b368b84 100644 --- a/source/guides/writing-pyproject-toml.rst +++ b/source/guides/writing-pyproject-toml.rst @@ -208,6 +208,11 @@ In this example, after installing your project, a ``spam-cli`` command will be available. Executing this command will do the equivalent of ``import sys; from spam import main_cli; sys.exit(main_cli())``. +Script entry points are written as :ref:`object references `, +such as ``importable.module`` or ``importable.module:object.attr``. For +script commands, the object reference should usually point to a callable object +that can be called with no arguments, rather than to a module by itself. + On Windows, scripts packaged this way need a terminal, so if you launch them from within a graphical application, they will make a terminal pop up. To prevent this from happening, use the ``[project.gui-scripts]``