Skip to content

Commit 7b99d25

Browse files
committed
update docs with new return value for create_config
1 parent f498a07 commit 7b99d25

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/source/examples/tools_example.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,10 @@ it will only run once. However, if you want to bypass this behavior,
9595
``check_and_build_global_config()`` takes an optional boolean ``skip_config_creation`` parameter that
9696
could be set to ``True`` at runtime to override the config creation.
9797

98+
``check_and_build_global_config()`` returns ``True`` if the config file exists (whether it created it or not)
99+
and ``False`` if the config file does not exist in the user's home allowing you to develop your own
100+
workflow for handling missing config files after running it with ``skip_config_creation=True``.
101+
98102
I entered the wrong information in my config file so it always loads incorrect information, how do I fix that?
99103
--------------------------------------------------------------------------------------------------------------
100104

0 commit comments

Comments
 (0)