[docs] [issue28951] re.flags not documented in Module Contents as promised.

kevin report at bugs.python.org
Fri Dec 16 22:08:24 EST 2016


kevin added the comment:

Ordinarily when I see a cross-reference like that "the flags are described
in foo" I expect foo to have a heading "FLAGS" so I can tell I'm looking at
what was promised.  Not knowing much about flags, it was not clear to me
that those scattered lines re.A through re.X were the promised
descriptions.  I didn't even notice them until now, partly because it's
made more confusing by all the stuff that's out of alphabetic order.  Or I
think it is -- it's hard to tell because of things like re.S and re.DOTALL
being together.  My current guess is that the uppercase things come before
lowercase, but those odd pairings are definitely messing with my mind.

All of which is just to say it probably makes perfect sense to someone
who's used to it, but it's hard on someone new to these docs, and I'm not
even new to Python, just to the re module.

On Mon, Dec 12, 2016 at 11:03 AM, R. David Murray <report at bugs.python.org>
wrote:

>
> R. David Murray added the comment:
>
> When I follow the link to module contents, I find a list of the flags with
> their descriptions.  (re.A, re.I, etc, etc).  Perhaps you are confusing the
> letters used in the regular expression to represent the flags with the
> flags themselves?  I'm not sure how we could make that clearer.
>
> ----------
> nosy: +r.david.murray
>
> _______________________________________
> Python tracker <report at bugs.python.org>
> <http://bugs.python.org/issue28951>
> _______________________________________
>

-- 
Kevin O'Gorman
#define QUESTION ((bb) || (!bb))   /* Shakespeare */

Please consider the environment before printing this email.

----------
Added file: http://bugs.python.org/file45934/unnamed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue28951>
_______________________________________
-------------- next part --------------
A non-text attachment was scrubbed...
Name: unnamed
Type: image/gif
Size: 441 bytes
Desc: not available
URL: <http://mail.python.org/pipermail/docs/attachments/20161217/f7434179/attachment.gif>


More information about the docs mailing list