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

[Oleg Iarygin]

Change by Oleg Iarygin :


--
keywords: +patch
pull_requests: +29877
stage:  -> patch review
pull_request: https://github.com/python/cpython/pull/31769

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Oleg Iarygin]

New submission from Oleg Iarygin :

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@python
components: Documentation, Extension Modules, Interpreter Core
messages: 414768
nosy: arhadthedev, docs@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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com