Repository navigation
Add separate match and case doc to pydoc #91177
Description
| BPO | 47021 |
|---|---|
| Nosy | @duckboycool |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2022-03-15.02:10:46.629>
labels = ['type-feature', 'library']
title = 'Add separate match and case doc to pydoc'
updated_at = <Date 2022-03-15.02:10:46.629>
user = 'https://github.com/duckboycool'bugs.python.org fields:
activity = <Date 2022-03-15.02:10:46.629>
actor = 'duckboycool'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2022-03-15.02:10:46.629>
creator = 'duckboycool'
dependencies = []
files = []
hgrepos = []
issue_num = 47021
keywords = []
message_count = 1.0
messages = ['415217']
nosy_count = 1.0
nosy_names = ['duckboycool']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue47021'
versions = []
Activity
duckboycool commentedon Mar 15, 2022
Currently pydoc (and therefore things like the interactive help prompt) do not have documentation for the soft-keywords "match" and "case".
I think that it would make sense for both of these prompts to give the docs for the match statement (https://docs.python.org/3/reference/compound_stmts.html#the-match-statement) similar to the other compound statements.
The "compound" doc already contains the match statement documentation, but is unnecessarily long at over 48000 characters, and is only accessed by the unhelpful named for this purpose "LOOPING" prompt. As soft keywords, they also might be best added in a separate section in "keywords" (and potentially with "_", although this already refers to "PRIVATENAMES" and is in "symbols").
A standalone match and case doc is not currently present in the Lib/pydoc_data/topics.py file automatically generated from documentation, and would need to be added in some way to do this.
hugovk commentedon Jan 7, 2025
This issue was reported earlier, but let's close as a duplicate of #105895, which has a PR. Thanks for the report!