Skip to content

docs: note that command() does not catch exceptions #10360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paulbalandan wants to merge 1 commit into
base: 4.8
Choose a base branch
from
Open

docs: note that command() does not catch exceptions #10360

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions user_guide_src/source/cli/spark_commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,8 @@ it from the command line.

All output from the command that is ran is captured when not run from the command line. It is returned from the command
so that you can choose to display it or not.

.. note:: The ``command()`` function does not catch exceptions thrown while the command runs.
:doc:`Modern commands <cli_modern_commands>` in particular throw when their input fails
validation, such as a missing required argument or an unknown option. Wrap the call in a
``try``/``catch`` block if you need to handle these cases.