Skip to content

Commit

Permalink
Removed parentheses.
Browse files Browse the repository at this point in the history
  • Loading branch information
mdlpstsci committed Aug 16, 2023
1 parent fe40c3a commit 87f46c4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/wfc3tools/wf3ir.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Running `wf3ir` from a Python Terminal
Displaying output from `wf3ir` in a Jupyter Notebook
----------------------------------------------------

When calling `wf3ir` from a Jupyter notebook, informational text output from the underlying `wf3ir.e` program will be passed through `print` as the calibration runs by default, and show up in the user's cell. This behavior can be customized by passing your own function as the `log_func` keyword argument to `wf3ir`. As output is read from the underlying program, the `wf3ir` Python wrapper will call `log_func` with the contents of each line. (`print` is an obvious choice for a log function, but this also provides a way to connect `wf3ir` to the Python logging system by passing the `logging.debug` function or similar.)
When calling `wf3ir` from a Jupyter notebook, informational text output from the underlying `wf3ir.e` program will be passed through `print` as the calibration runs by default, and show up in the user's cell. This behavior can be customized by passing your own function as the `log_func` keyword argument to `wf3ir`. As output is read from the underlying program, the `wf3ir` Python wrapper will call `log_func` with the contents of each line. `print` is an obvious choice for a log function, but this also provides a way to connect `wf3ir` to the Python logging system by passing the `logging.debug` function or similar.

If `log_func=None` is passed, informational text output from the underlying program will be ignored, but the program's exit code will still be checked for successful completion.

Expand Down

0 comments on commit 87f46c4

Please sign in to comment.