[New-bugs-announce] [issue47021] Add separate match and case doc to pydoc

Duck report at bugs.python.org
Mon Mar 14 22:10:46 EDT 2022

New submission from Duck <duckboycool101 at gmail.com>:

Currently pydoc (and therefore things like the interactive help prompt) do not have documentation for the soft-keywords "match" and "case".

help> match
No Python documentation found for 'match'.
Use help() to get the interactive help utility.
Use help(str) for help on the str class.

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.

components: Library (Lib)
messages: 415217
nosy: duckboycool
priority: normal
severity: normal
status: open
title: Add separate match and case doc to pydoc
type: enhancement

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list