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: Make doc strings optional
Type: Stage:
Components: Interpreter Core Versions: Python 2.3
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: loewis Nosy List: gvanrossum, loewis, niemeyer
Priority: normal Keywords: patch

Created on 2002-01-18 14:00 by niemeyer, last changed 2022-04-10 16:04 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
python-2.3a0-docstr.patch niemeyer, 2002-06-06 21:22 Patch updated to current CVS
Messages (6)
msg38743 - (view) Author: Gustavo Niemeyer (niemeyer) * (Python committer) Date: 2002-01-18 14:00
As discussed in python-dev, documentation strings are 
responsible for 10% of python's executable footprint. 
This patch tries to merge everyone's idea about how 
documentation strings should be optional.

Please note that, for now, only sysmodule.c is using 
the new macros. When this patch get in, I (and 
others, maybe) will gradually implement these macros 
in all documentation strings available in python's 
code.

Reference:
http://mail.python.org/pipermail/python-dev/2002-January/019392.html
msg38744 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2002-06-04 17:25
Logged In: YES 
user_id=21627

Can you please update the patch to the current code base?
Notice that pyconfig.h.in is a generated file, generated by
autoheader; you need to split this change into configure.in
and Include/something changes (something probably being
Python.h)
msg38745 - (view) Author: Gustavo Niemeyer (niemeyer) * (Python committer) Date: 2002-06-06 16:45
Logged In: YES 
user_id=7887

I'll work on it. Thanks! 
msg38746 - (view) Author: Gustavo Niemeyer (niemeyer) * (Python committer) Date: 2002-06-06 21:22
Logged In: YES 
user_id=7887

Here's the new patch updated to  CVS. 
 
Just like before, I've introduced the new macros only in sysmodule.c. I chose 
this file given it's specific (unusual) requirements about doc strings. Once 
these macros are checked in, I'll promptly implement this functionality in 
everything else. 
 
Thanks! 
msg38747 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2002-06-07 13:00
Logged In: YES 
user_id=6380

Go for it.
msg38748 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2002-06-09 13:43
Logged In: YES 
user_id=21627

Thanks for the patch. Committed as 
configure 1.312
configure.in 1.322
pyconfig.h.in 1.39
Python.h 2.51
NEWS 1.420
sysmodule.c 2.104

I have also updated the various manually-maintained
pyconfig.h files to enable doc strings. Feel free to submit
further patches (perhaps on a per-directory basis).
History
Date User Action Args
2022-04-10 16:04:53adminsetgithub: 35941
2002-01-18 14:00:53niemeyercreate