maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

📚 Improve docs about ScriptInfo

Browse source 
Improve documentation for the CLI using application factories and
how/when the ScriptInfo object is passed with Application Discovery
This commit is contained in:
Jeremy Mayeres 2018-07-20 19:20:04 +02:00
parent 06b189b6be
commit c7791bb526
No known key found for this signature in database
GPG key ID: 2FC01E0BCB638723
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/cli.rst
View file

@ -78,10 +78,12 @@ found, the command looks for a factory function named ``create_app`` or
``make_app`` that returns an instance.
When calling an application factory, if the factory takes an argument named
``info``, then the :class:`~cli.ScriptInfo` instance is passed as a keyword
argument. If parentheses follow the factory name, their contents are parsed
as Python literals and passes as arguments to the function. This means that
strings must still be in quotes.
``script_info``, then the :class:`~cli.ScriptInfo` instance is passed as a
keyword argument. If the application factory takes only one argument and no
parentheses follow the factory name, the :class:`~cli.ScriptInfo` instance
is passed as a positional argument. If parentheses follow the factory name,
their contents are parsed as Python literals and passes as arguments to the
function. This means that strings must still be in quotes.
Run the Development Server