Use xdoctest instead of doctest for better error handling. (conda#11018)

xylar · Nov 4, 2021 · 23aba44 · 23aba44
1 parent b3e44db
commit 23aba44
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/conda/cli/python_api.py b/conda/cli/python_api.py
@@ -68,12 +68,11 @@ def run_command(command, *arguments, **kwargs):
 
     Examples::
 
-    >>  run_command(Commands.CREATE, "-n", "newenv", "python=3", "flask",
+    >>  run_command(Commands.CREATE, "-n", "newenv", "python=3", "flask", \
                     use_exception_handler=True)
     >>  run_command(Commands.CREATE, "-n", "newenv", "python=3", "flask")
     >>  run_command(Commands.CREATE, ["-n", "newenv", "python=3", "flask"], search_path=())
 
-
     """
     initialize_std_loggers()
     use_exception_handler = kwargs.pop('use_exception_handler', False)

diff --git a/setup.cfg b/setup.cfg
@@ -13,7 +13,8 @@ addopts =
     --tb native
     --strict-markers
     --durations 16
-    --doctest-modules
+    --xdoctest-modules
+    --xdoctest-style=google
     --cov-report xml
     --cov-report term-missing
     --cov conda
@@ -22,6 +23,7 @@ doctest_optionflags =
     NORMALIZE_WHITESPACE
     IGNORE_EXCEPTION_DETAIL
     ALLOW_UNICODE
+    ELLIPSIS
 markers =
     integration: integration tests that usually require an internet connect
     slow: slow running tests

diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -8,6 +8,7 @@ conda-build
 conda-package-handling
 conda-verify
 conda-forge::pytest-split
+conda-forge::xdoctest
 cytoolz
 filelock
 flake8