Open EFord36 opened 8 months ago
By the way, I noticed this because I was looking at the big comment explaining URL_REGEX
, and though "maybe this is a good use case for re.verbose", which I think is a very useful but seemingly not especially well known feature of the re
module that helps document complex regular expressions - I thought maybe it would help stop the comment explaining the different bits of the regex from falling out of sync with the actual regex - only to find this issue, where this seems to have actually happened.
If (after this issue is resolved) I submitted a PR to try writing a 'verbose' version of this regex with explanation 'inline', is this something you would be interested in?
could probably be 'compiled' with re.compile
to prevent re-parsing of the
comparing the 'URL_REGEX explanation comment':
to the actual first line of the regex:
the actual regex seems to be 'missing' a
|
between:and
This seems to have been removed in https://github.com/PyCQA/docformatter/pull/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.