Skip to content

Commit

Permalink
docs: Document AUGUR_DEBUG on our env vars page…
Browse files Browse the repository at this point in the history
…instead of in the developer API pages.  Much more discoverable outside
of the dev pages.

Modifies formatting of the rST to match the new document's existing
formatting, but the content is the same.

Thanks to @joverlee521 for catching this misplacement in post-merge
review.¹

¹ <#1577 (comment)>
  • Loading branch information
tsibley committed Aug 20, 2024
1 parent 68fcdaf commit 86cefd7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
6 changes: 1 addition & 5 deletions augur/debug.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
"""
Debug flags and utilities.
.. envvar:: AUGUR_DEBUG
Set to a truthy value (e.g. 1) to print more information about (handled)
errors. For example, when this is not set or falsey, stack traces and
parent exceptions in an exception chain are omitted from handled errors.
See also :envvar:`AUGUR_DEBUG`.
"""
from os import environ

Expand Down
7 changes: 7 additions & 0 deletions docs/usage/envvars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ Environment variables
Augur's behaviour can be globally modified by the values of some specific environment variables.
These can be especially useful in the context of an entire pipeline or workflow which uses Augur, as the environment variables can be set once for all Augur commands at the start of the pipeline.

.. envvar:: AUGUR_DEBUG

Boolean.
Set to a truthy value (e.g. 1) to print more information about (handled) errors.

For example, when this is not set or falsey, stack traces and parent exceptions in an exception chain are omitted from handled errors.

.. envvar:: AUGUR_MINIFY_JSON

Boolean.
Expand Down

0 comments on commit 86cefd7

Please sign in to comment.