[New-bugs-announce] [issue46962] Fix docstrings that do not honor --without-doc-strings

Oleg Iarygin report at bugs.python.org
Tue Mar 8 13:59:44 EST 2022


New submission from Oleg Iarygin <oleg at arhadthedev.net>:

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*"`.

----------
assignee: docs at python
components: Documentation, Extension Modules, Interpreter Core
messages: 414768
nosy: arhadthedev, docs at python
priority: normal
severity: normal
status: open
title: Fix docstrings that do not honor --without-doc-strings
type: behavior
versions: Python 3.11

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue46962>
_______________________________________


More information about the New-bugs-announce mailing list