Python 3.0a documentation
I'd like to help out cleaning up the Python3.0 documentation. There are a lot of little leftovers from 2.x that are no longer true. (mentions of long, callable() etc.) Ideally (especially in the tutorial), we should only refer to 3.0 features and syntax, and keep the special cases and "other ways to do it" to a minimum. Before I dive in and start submitting patches, what does everyone else think? How much reference to previous python versions should be left in? Does it make sense to keep notes of the nature of "since version 2.3 ..." when there is an intentional discontinuity at 3.0? Peter Harris
I fully support removing all historic references from the 3.0 language
manual. Please do help out! You can just start putting patches ("svn
diff") into bugs.python.org; typically Georg gets to these very
quickly. Do use subversion, not the distributed tarbal (which was out
of date by the time it was uploaded to python.org. :-).
--Guido
On 9/26/07, scav@blueyonder.co.uk
I'd like to help out cleaning up the Python3.0 documentation. There are a lot of little leftovers from 2.x that are no longer true. (mentions of long, callable() etc.)
Ideally (especially in the tutorial), we should only refer to 3.0 features and syntax, and keep the special cases and "other ways to do it" to a minimum.
Before I dive in and start submitting patches, what does everyone else think? How much reference to previous python versions should be left in? Does it make sense to keep notes of the nature of "since version 2.3 ..." when there is an intentional discontinuity at 3.0?
Peter Harris
_______________________________________________ Python-Dev mailing list Python-Dev@python.org http://mail.python.org/mailman/listinfo/python-dev Unsubscribe: http://mail.python.org/mailman/options/python-dev/guido%40python.org
-- --Guido van Rossum (home page: http://www.python.org/~guido/)
Guido> I fully support removing all historic references from the 3.0 Guido> language manual. By historic I assume you mean references to 2.x modules, classes, functions, etc which are no longer present. One thing I would suggest is that the more recent versionadded strings be kept. At the very least, if something is going to be new in 2.6, keep that. Maybe also keep the 2.5 versionadded references. Older references can probably be deleted. Skip
On 9/26/07, skip@pobox.com
Guido> I fully support removing all historic references from the 3.0 Guido> language manual.
By historic I assume you mean references to 2.x modules, classes, functions, etc which are no longer present. One thing I would suggest is that the more recent versionadded strings be kept. At the very least, if something is going to be new in 2.6, keep that. Maybe also keep the 2.5 versionadded references. Older references can probably be deleted.
In the 2.x docs, all versionadded strings should stay. But IMO in the 3.0 docs we should get rid of them all. If you want compatibility information, look at the 2.6 docs (those should also mention things that are changing in 3.0). -- --Guido van Rossum (home page: http://www.python.org/~guido/)
In the 2.x docs, all versionadded strings should stay. But IMO in the 3.0 docs we should get rid of them all. If you want compatibility information, look at the 2.6 docs (those should also mention things that are changing in 3.0).
I agree. People who target 3.x need to test anyway if they also want to support some 2.x version (if that is possible at all), so it does not help them to know what Python version introduced a certain feature they use. Regards, Martin
Martin v. Löwis schrieb:
In the 2.x docs, all versionadded strings should stay. But IMO in the 3.0 docs we should get rid of them all. If you want compatibility information, look at the 2.6 docs (those should also mention things that are changing in 3.0).
I agree. People who target 3.x need to test anyway if they also want to support some 2.x version (if that is possible at all), so it does not help them to know what Python version introduced a certain feature they use.
Also, it has already been done, and would be painful to undo :) Georg -- Thus spake the Lord: Thou shalt indent with four spaces. No more, no less. Four shall be the number of spaces thou shalt indent, and the number of thy indenting shall be four. Eight shalt thou not indent, nor either indent thou two, excepting that thou then proceed to four. Tabs are right out.
scav@blueyonder.co.uk schrieb:
I'd like to help out cleaning up the Python3.0 documentation. There are a lot of little leftovers from 2.x that are no longer true. (mentions of long, callable() etc.)
I've applied the first four patches, thank you! Georg -- Thus spake the Lord: Thou shalt indent with four spaces. No more, no less. Four shall be the number of spaces thou shalt indent, and the number of thy indenting shall be four. Eight shalt thou not indent, nor either indent thou two, excepting that thou then proceed to four. Tabs are right out.
participants (5)
-
"Martin v. Löwis" -
Georg Brandl -
Guido van Rossum -
scav＠blueyonder.co.uk -
skip＠pobox.com