Wrong admonition reformat on `v1.6.0.rc1`

[kdeldycke]

I am using docformatter 1.5.0 for a couple of month now by invoking the following CLI, which always worked fine:

$ docformatter --recursive --in-place --wrap-summaries 88 --wrap-descriptions 88 .

In order to test for the fix for #140, I updated to v1.6.0.rc1. Now the same call with the same parameters always exits with error code 3. See the log from my GitHub action:

$ docformatter --recursive --in-place --wrap-summaries 88 --wrap-descriptions 88 .
(...)
Error: Process completed with exit code 3.

How to reproduce

First, install v1.6.0.rc1:

$ pipx install git+https://github.com/PyCQA/docformatter.git@v1.6.0.rc1
  installed package docformatter 1.5.1, installed using Python 3.11.1
  These apps are now globally available
    - docformatter
done! ✨ 🌟 ✨

$ docformatter --version
docformatter 1.5.0

BTW, notice how the package is reported as 1.5.1 by pipx and 1.5.0 by docformatter itself. This is a confusing issue due to the 1.6.0.rc1 version string not being set in the development branch. Inspecting the code reveal pipx is perfectly doing its job and that's really is the v1.6.0.rc1 branch code we are running. For proof, the presence of the URL_PATTERNS constant that was added in commit 917fed92248d1fb91a1f4da61b5aaaec7367fe23:

$ grep -A 4 'URL_PATTERNS =' ~/.local/pipx/venvs/docformatter/lib/python3.11/site-packages/docformatter/syntax.py
URL_PATTERNS = (
    "afp|"
    "apt|"
    "bitcoin|"
    "chrome|"

Now that we run 1.6.0.rc1, let's download a minimal file from my project:

$ wget "https://raw.githubusercontent.com/kdeldycke/click-extra/86991e4023a962ff14e0ec774e534e118ad3b56e/click_extra/platform.py"
(...)
2023-01-24 (11.3 MB/s) - ‘platform.py’ saved

And run docformatter on it:

$ docformatter --recursive --in-place --wrap-summaries 88 --wrap-descriptions 88 ./platform.py
$ echo $?
3

Hypothesis

If we run the same command as above, on the same file, with the extra --diff parameter, we get:

$ docformatter --recursive --in-place --wrap-summaries 88 --wrap-descriptions 88 --diff ./platform.py

--- before/./platform.py
+++ after/./platform.py
@@ -21,9 +21,9 @@
 
 .. warning::
 
-    ``click_extra.platform`` is deprecated since version 3.8.0.
+``click_extra.platform`` is deprecated since version 3.8.0.
 
-    Use ``click_extra.platforms`` (with a trailing ``s``) instead.
+Use ``click_extra.platforms`` (with a trailing ``s``) instead.
 """
 
 import warnings

$ echo $?
3

Is the strange reformatting, which doesn't seems to recognize the .. warning:: admonition, can explain the constant exit with code 3?

[kdeldycke]

OK, looking at the recent changes, it seems returning exit code 3 is expected.

If that's the case, maybe I should requalify this issue, as the admonition formatting I pointed to as my last hypothesis is still valid right? What your opinion @weibullguy ?

[weibullguy]

@kdeldycke I agree the admonition is what docformatter is tripping over. I removed the first regex in the is_some_kind_of_list() function to fix the problem reported in #127. I just added a regex to that function to look specifically for admonitions and not process them. After v1.6.0 is released, I'm going to start tackling all the issues having to do with reST directives for v1.7.0.

Yes, the non-zero return code was requested to make pre-commit fail if docformatter id'd any changes in --check mode.

I just pushed the fix for the admonition and updated the version info. Tag v1.6.0-rc2 contains both fixes. Thanks for taking the time to test the RCs and provide feedback.

[kdeldycke]

Thanks @weibullguy for the fast reply! I'm currently test-driving v1.6.0-rc2 and will report issues.

In the mean time, I rename this issue to refer to admonition formatting as the 3 exit code is not a bug but a feature.