I believe URL_REGEX is missing a |
#269
Labels
C: style
Relates to docstring format style (e.g., Google, NumPy, Sphinx)
P: enhancement
Feature that is outside the scope of PEP 257
U: low
A relatively low urgency issue
comparing the 'URL_REGEX explanation comment':
# (__ |`{{2}}|`\w[\w. :\n]*|\.\. _?[\w. :]+|')? is used to find in-line links that
to the actual first line of the regex:
rf"(__ |`{{2}}|`\w[\w :#\n]*[.|\.\. _?[\w. :]+|')?<?"
the actual regex seems to be 'missing' a
|
between:and
This seems to have been removed in #213 , which doesn't seem intentional to me, as it doesn't seem obviously related to the change that PR was trying to fix (although it's possible I'm misunderstanding here, sorry if so!).
I think this does affect the wrapping behaviour - links in the format starting with
..
seem to not get wrapped (although I'm not 100% sure I've understand the expected behaviour). A file with these contents:produces this output when docformatter is run over it, only reformatting the link with a different format:
I think maybe this isn't obvious/impactful because this kind of link is 'explicit markup' that according to ReST can only start a line of ReST, so it's probably infrequent that you get a link and reference long enough that this would reformat it anyway.
The text was updated successfully, but these errors were encountered: