Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.6.1 - Newlines inserted around hyperlinks #180

Closed
rmartin16 opened this issue Apr 22, 2023 · 0 comments · Fixed by #182
Closed

v1.6.1 - Newlines inserted around hyperlinks #180

rmartin16 opened this issue Apr 22, 2023 · 0 comments · Fixed by #182
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented
Milestone

Comments

@rmartin16
Copy link

Ran v1.6.1 and encountered this situation.

  • config:
  - repo: https://github.com/PyCQA/docformatter
    rev: v1.6.1
    hooks:
      - id: docformatter
        args: [--in-place, --wrap-descriptions=88, --wrap-summaries=88]
  • On the first pass, these hyperlinks are pushed to the next line with an additional newline above them.
  • On the second pass, another newline is added above them.
  • On the third pass, docformatter doesn't make additional changes.
❯ 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

❯ 
@github-actions github-actions bot added the fresh This is a new issue label Apr 22, 2023
@weibullguy weibullguy added P: bug PEP 257 violation or existing functionality that doesn't work as documented C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) and removed fresh This is a new issue labels Apr 23, 2023
@weibullguy weibullguy added this to the v1.7.0 milestone Apr 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants