PyCQA / docformatter

Formats docstrings to follow PEP 257
https://pypi.python.org/pypi/docformatter
MIT License
526 stars 61 forks source link

v1.6.1 - Newlines inserted around hyperlinks #180

Closed rmartin16 closed 1 year ago

rmartin16 commented 1 year ago

Ran v1.6.1 and encountered this situation.

❯ cat test.py
"""Django settings for webapp project.

Generated by 'django-admin startproject' using Django 4.1.1.

For more information on this file, see https://docs.djangoproject.com/en/4.1/topics/settings/

For the full list of settings and their values, see https://docs.djangoproject.com/en/4.1/ref/settings/
"""

❯ pre-commit run docformatter --files test.py 
docformatter.............................................................Failed
- hook id: docformatter
- exit code: 3

❯ cat test.py
"""Django settings for webapp project.

Generated by 'django-admin startproject' using Django 4.1.1.

For more information on this file, see

https://docs.djangoproject.com/en/4.1/topics/settings/

For the full list of settings and their values, see

https://docs.djangoproject.com/en/4.1/ref/settings/
"""

❯ pre-commit run docformatter --files test.py 
docformatter.............................................................Failed
- hook id: docformatter
- exit code: 3

❯ cat test.py
"""Django settings for webapp project.

Generated by 'django-admin startproject' using Django 4.1.1.

For more information on this file, see

https://docs.djangoproject.com/en/4.1/topics/settings/

For the full list of settings and their values, see

https://docs.djangoproject.com/en/4.1/ref/settings/
"""

❯ pre-commit run docformatter --files test.py 
docformatter.............................................................Passed

❯