Fix docstrings that do not honor --without-doc-strings

[arhadthedev]

BPO	46962
Nosy	@arhadthedev
PRs	gh-91118: Fix docstrings that do not honor --without-doc-strings #31769

^{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-08.18:59:44.544>
labels = ['extension-modules', 'interpreter-core', '3.11', 'type-bug', 'docs']
title = 'Fix docstrings that do not honor --without-doc-strings'
updated_at = <Date 2022-03-08.19:01:28.471>
user = 'https://github.com/arhadthedev'

bugs.python.org fields:

activity = <Date 2022-03-08.19:01:28.471>
actor = 'arhadthedev'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Extension Modules', 'Interpreter Core']
creation = <Date 2022-03-08.18:59:44.544>
creator = 'arhadthedev'
dependencies = []
files = []
hgrepos = []
issue_num = 46962
keywords = ['patch']
message_count = 1.0
messages = ['414768']
nosy_count = 2.0
nosy_names = ['docs@python', 'arhadthedev']
pr_nums = ['31769']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue46962'
versions = ['Python 3.11']

[arhadthedev]

To support --without-doc-strings, all docstrings must be wrapped into PyDoc_STRVAR or PyDoc_STR (PEP-7). However, there are 18 occurrences in code and 10 in C API documentation that do not follow this rule. The documentation is important too because it should not teach people the wrong things.

To find the occurrences I searched for (?:^\s*.tp_doc = "|" \/\* tp_doc \*\/$) and^(?:static\s+)?const\s+char\s+[^=]+=\s*".

[JelleZijlstra]

Reopening until the backports are done.