From 7fb2ddcaf613438820a4c095ba9c972e41fc154b Mon Sep 17 00:00:00 2001 From: David Lord Date: Sun, 28 Jan 2018 14:25:48 -0800 Subject: [PATCH] add note about syntax errors in custom scripts mention pycharm version support --- docs/cli.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/cli.rst b/docs/cli.rst index b82d5aff..e378a91a 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -355,15 +355,25 @@ script is available. Note that you don't need to set ``FLASK_APP``. :: $ pip install -e . $ wiki run +.. admonition:: Errors in Custom Scripts + + When using a custom script, if you introduce an error in your + module-level code, the reloader will fail because it can no longer + load the entry point. + + The ``flask`` command, being separate from your code, does not have + this issue and is recommended in most cases. + .. _console script: https://packaging.python.org/tutorials/distributing-packages/#console-scripts PyCharm Integration ------------------- -The Flask CLI features aren't yet fully integrated into the PyCharm IDE, -so we have to do a few tweaks to get them working smoothly. These -instructions should be similar for any other IDE you might want to use. +Prior to PyCharm 2018.1, the Flask CLI features weren't yet fully +integrated into PyCharm. We have to do a few tweaks to get them working +smoothly. These instructions should be similar for any other IDE you +might want to use. In PyCharm, with your project open, click on *Run* from the menu bar and go to *Edit Configurations*. You'll be greeted by a screen similar to