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.

Sign up for GitHub

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

Jump to bottom

Breaking long line does not preserve links #75

Closed
Borda opened this issue Aug 2, 2021 · 1 comment · Fixed by #115
Closed

Breaking long line does not preserve links #75

Borda opened this issue Aug 2, 2021 · 1 comment · Fixed by #115
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
v2.0.0

Comments

@Borda
Copy link

Borda commented Aug 2, 2021

Hi, first, for this nice tool!
We crossed some difficulty with long links which are split into multiple lines (when a line is over 120 chars) but then it is not valid link anymore, for example this one:

`Area Under the Receiver Operating Characteristic Curve (ROC AUC)
    <https://en.wikipedia.org/wiki/Receiver_operating_characteristic#Further_interpretations>`_.

is there some solution for such a case? for example, do when the link is too long start automatically on a new line and even the line is too long, do not break it...
@Borda Borda mentioned this issue Aug 2, 2021
Merged
4 tasks
@DanielNoord DanielNoord mentioned this issue Dec 31, 2021
Closed
@DanielNoord DanielNoord mentioned this issue Feb 5, 2022
Closed
@weibullguy weibullguy added the P: enhancement Feature that is outside the scope of PEP 257 label Jul 24, 2022
@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 P: enhancement Feature that is outside the scope of PEP 257 labels Aug 10, 2022
@weibullguy weibullguy added this to the v2.0.0 milestone Aug 21, 2022
@weibullguy weibullguy mentioned this issue Aug 22, 2022
Merged
@Borda
Copy link
Author

Borda commented Oct 4, 2022 •
edited

It seems I am facing something similar with v1.5, see: Lightning-AI/torchmetrics@265274c or is this the correct way?

If I understand, it will be fixed in v2.0... so it there ETA for this release?

@Borda Borda mentioned this issue Oct 4, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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
Milestone
v2.0.0
Development

Successfully merging a pull request may close this issue.

fix: don't wrap URLs PyCQA/docformatter
2 participants
@Borda @weibullguy