➜

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: Fix docstrings that do not honor --without-doc-strings
Type: behavior Stage: patch review
Components: Documentation, Extension Modules, Interpreter Core Versions: Python 3.11
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: arhadthedev, docs@python
Priority: normal Keywords: patch

Created on 2022-03-08 18:59 by arhadthedev, last changed 2022-04-11 14:59 by admin.

Pull Requests
URL Status Linked Edit
PR 31769 open arhadthedev, 2022-03-08 19:01
Messages (1)
msg414768 - (view) Author: Oleg Iarygin (arhadthedev) * Date: 2022-03-08 18:59 
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*"`.
History
Date User Action Args
2022-04-11 14:59:57adminsetgithub: 91118
2022-03-08 19:01:28arhadthedevsetkeywords: + patch
stage: patch review
pull_requests: + pull_request29877
2022-03-08 18:59:44arhadthedevcreate