This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Metacharacter (\) documentation suggestion
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.11
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: JelleZijlstra, docs@python, jack__d, kdraeder, mikecmcleod, miss-islington, slateny
Priority: normal Keywords: easy, newcomer friendly, patch

Created on 2018-01-25 00:01 by kdraeder, last changed 2022-04-11 14:58 by admin.

Pull Requests
URL Status Linked Edit
PR 32230 merged mikecmcleod, 2022-04-01 10:54
PR 32322 merged miss-islington, 2022-04-05 02:47
PR 32323 merged miss-islington, 2022-04-05 02:47
Messages (12)
msg310647 - (view) Author: Kevin Raeder (kdraeder) Date: 2018-01-25 00:01
I've found the Regular Expression HOWTO to be very helpful
(https://docs.python.org/3/howto/regex.html?highlight=regular%20expressions). 
One inconsistency I noticed is that the intro to metacharacters says
"Metacharacters are not active inside classes. "
But farther down we learn that a class can be constructed using \s: [\s,.],
which is "all white space characters , and ."
It's not the 4 characters "\ s , and ."
So I think the first statement would be clearer as
"Metacharacters (except \) are not active inside classes. "
msg411165 - (view) Author: mike mcleod (mikecmcleod) * Date: 2022-01-21 17:42
I would like to help with this issue. Is that acceptable?
msg411195 - (view) Author: Kevin Raeder (kdraeder) Date: 2022-01-21 22:00
Sure!  Thanks for paying attention to my suggestion.
Kevin

On Fri, Jan 21, 2022 at 10:42 AM mike mcleod <report@bugs.python.org> wrote:

>
> mike mcleod <mikecmcleod@gmail.com> added the comment:
>
> I would like to help with this issue. Is that acceptable?
>
> ----------
> nosy: +mikecmcleod
>
> _______________________________________
> Python tracker <report@bugs.python.org>
> <https://bugs.python.org/issue32658>
> _______________________________________
>
msg416241 - (view) Author: Stanley (slateny) * Date: 2022-03-29 03:57
Mike, are you still working on this issue?
msg416250 - (view) Author: mike mcleod (mikecmcleod) * Date: 2022-03-29 10:07
Sorry, forgot this one. Would you like me to move this forward? Or do you want to take it? I don't mind either way.
msg416311 - (view) Author: Stanley (slateny) * Date: 2022-03-30 00:42
Feel free, it's all yours
msg416445 - (view) Author: mike mcleod (mikecmcleod) * Date: 2022-03-31 16:07
After sync'ing to upstream/main and then running make html I get: ...
checking consistency... done
preparing documents... failed

Warning, treated as error:
unsupported theme option 'license_url' given
make: *** [Makefile:53: build] Error 2

I cant see anything from googling the error above.
This is before I have made any changes.
msg416486 - (view) Author: Jack DeVries (jack__d) * Date: 2022-04-01 13:10
Did you run ``make venv`` to setup your virtual environment? Sphynx themes are usually pip dependencies, so if you're getting a "missing theme" error, it sounds like your virtual environment is not setup right.
msg416725 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2022-04-05 02:47
New changeset 43571a3eea8b5931769376daf4bdad1c9184ae0d by Mike cm in branch 'main':
bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)
https://github.com/python/cpython/commit/43571a3eea8b5931769376daf4bdad1c9184ae0d
msg416726 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2022-04-05 02:47
Thanks for the patch!
msg416733 - (view) Author: miss-islington (miss-islington) Date: 2022-04-05 03:08
New changeset d95e072c419e40b0fb67b8cc8a84087c8a0276ee by Miss Islington (bot) in branch '3.10':
bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)
https://github.com/python/cpython/commit/d95e072c419e40b0fb67b8cc8a84087c8a0276ee
msg416734 - (view) Author: miss-islington (miss-islington) Date: 2022-04-05 03:11
New changeset 31c9e35e5360ba91fc6b81b23eb21dd3c39e2257 by Miss Islington (bot) in branch '3.9':
bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)
https://github.com/python/cpython/commit/31c9e35e5360ba91fc6b81b23eb21dd3c39e2257
History
Date User Action Args
2022-04-11 14:58:57adminsetgithub: 76839
2022-04-05 03:11:44miss-islingtonsetmessages: + msg416734
2022-04-05 03:08:24miss-islingtonsetmessages: + msg416733
2022-04-05 02:47:42JelleZijlstrasetmessages: + msg416726
2022-04-05 02:47:37miss-islingtonsetpull_requests: + pull_request30384
2022-04-05 02:47:14JelleZijlstrasetnosy: + JelleZijlstra
messages: + msg416725
2022-04-05 02:47:05miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request30383
2022-04-01 13:10:15jack__dsetnosy: + jack__d
messages: + msg416486
2022-04-01 10:54:22mikecmcleodsetkeywords: + patch
stage: patch review
pull_requests: + pull_request30302
2022-03-31 16:07:44mikecmcleodsetmessages: + msg416445
2022-03-30 00:42:41slatenysetmessages: + msg416311
2022-03-29 10:07:45mikecmcleodsetmessages: + msg416250
2022-03-29 03:57:36slatenysetnosy: + slateny
messages: + msg416241
2022-01-21 22:00:20kdraedersetmessages: + msg411195
2022-01-21 17:42:30mikecmcleodsetnosy: + mikecmcleod
messages: + msg411165
2021-11-21 15:30:23AlexWaygoodsettype: enhancement
2021-11-21 14:48:46iritkatrielsetkeywords: + easy, newcomer friendly
versions: + Python 3.11
2018-01-25 00:01:01kdraedercreate