[Patches] Acknowledgements: docstrings -> comments
Gerrit Holl
Gerrit <gerrit@nl.linux.org>
Sun, 27 Feb 2000 10:39:15 +0100
--sm4nu43k4a2Rpi4c
Content-Type: text/plain; charset=us-ascii
[according to the archives, this mail didn't reach the list, if it did - sorry]
Hello,
the attached patch moves all acknowledgements for authors from
docstrings to normal comments. It also adds one line to the
docstring of StringIO, namely that cStringIO is also available.
I did not do it extremely careful, so it's possible that
there's an acknowledgement left in a docstring (e.g., I only
did module docstrings).
Output of 'diff -cr /tmp/Lib/ .' is attached, where /tmp/Lib contains
the old standard library and . the changed one.
DISCLAIMER
~~~~~~~~~~
I confirm that, to the best of my knowledge and belief, this
contribution is free of any claims of third parties under
copyright, patent or other rights or interests ("claims"). To
the extent that I have any such claims, I hereby grant to CNRI a
nonexclusive, irrevocable, royalty-free, worldwide license to
reproduce, distribute, perform and/or display publicly, prepare
derivative versions, and otherwise use this contribution as part
of the Python software and its related documentation, or any
derivative versions thereof, at no cost to CNRI or its licensed
users, and to authorize others to do so.
I acknowledge that CNRI may, at its sole discretion, decide
whether or not to incorporate this contribution in the Python
software and its related documentation. I further grant CNRI
permission to use my name and other identifying information
provided to CNRI by me for use in connection with the Python
software and its related documentation.
regards,
Gerrit.
--
Comparison Python GUI's: http://www.nl.linux.org/~gerrit/gui.html
Please comment!
--sm4nu43k4a2Rpi4c
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="acks.YMd3oX.diff"
diff -cr /tmp/Lib/StringIO.py ./StringIO.py
*** /tmp/Lib/StringIO.py Wed Feb 2 16:10:14 2000
--- ./StringIO.py Sun Feb 27 10:13:36 2000
***************
*** 19,24 ****
--- 19,26 ----
Notes:
- Using a real file is often faster (but less convenient).
+ - There's also a much faster implementation in C, called cStringIO, but
+ it's not subclassable.
- fileno() is left unimplemented so that code which uses it triggers
an exception early.
- Seeking far beyond EOF and then writing will insert real null
diff -cr /tmp/Lib/cgi.py ./cgi.py
*** /tmp/Lib/cgi.py Fri Feb 25 12:44:03 2000
--- ./cgi.py Sun Feb 27 10:15:20 2000
***************
*** 399,420 ****
- Don't try to give a CGI script a set-uid mode. This doesn't work on
most systems, and is a security liability as well.
-
- History
- -------
-
- Michael McLay started this module. Steve Majewski changed the
- interface to SvFormContentDict and FormContentDict. The multipart
- parsing was inspired by code submitted by Andreas Paepcke. Guido van
- Rossum rewrote, reformatted and documented the module and is currently
- responsible for its maintenance.
-
-
XXX The module is getting pretty heavy with all those docstrings.
Perhaps there should be a slimmed version that doesn't contain all those
backwards compatible and debugging classes and functions?
"""
__version__ = "2.2"
--- 399,419 ----
- Don't try to give a CGI script a set-uid mode. This doesn't work on
most systems, and is a security liability as well.
XXX The module is getting pretty heavy with all those docstrings.
Perhaps there should be a slimmed version that doesn't contain all those
backwards compatible and debugging classes and functions?
"""
+
+ # History
+ # -------
+ #
+ # Michael McLay started this module. Steve Majewski changed the
+ # interface to SvFormContentDict and FormContentDict. The multipart
+ # parsing was inspired by code submitted by Andreas Paepcke. Guido van
+ # Rossum rewrote, reformatted and documented the module and is currently
+ # responsible for its maintenance.
+ #
__version__ = "2.2"
diff -cr /tmp/Lib/code.py ./code.py
*** /tmp/Lib/code.py Thu Oct 22 23:56:44 1998
--- ./code.py Sun Feb 27 10:15:44 2000
***************
*** 1,7 ****
"""Utilities needed to emulate Python's interactive interpreter.
- Inspired by similar code by Jeff Epler and Fredrik Lundh.
"""
import sys
--- 1,8 ----
"""Utilities needed to emulate Python's interactive interpreter.
"""
+
+ # Inspired by similar code by Jeff Epler and Fredrik Lundh.
import sys
diff -cr /tmp/Lib/ftplib.py ./ftplib.py
*** /tmp/Lib/ftplib.py Fri Feb 4 16:39:29 2000
--- ./ftplib.py Sun Feb 27 10:17:39 2000
***************
*** 1,12 ****
"""An FTP client class and some helper functions.
Based on RFC 959: File Transfer Protocol
- (FTP), by J. Postel and J. Reynolds
-
- Changes and improvements suggested by Steve Majewski.
- Modified by Jack to work on the mac.
- Modified by Siebren to support docstrings and PASV.
-
Example:
--- 1,6 ----
***************
*** 33,38 ****
--- 27,38 ----
A nice test that reveals some of the network dialogue would be:
python ftplib.py -d localhost -l -p -l
"""
+
+ # (FTP), by J. Postel and J. Reynolds
+ #
+ # Changes and improvements suggested by Steve Majewski.
+ # Modified by Jack to work on the mac.
+ # Modified by Siebren to support docstrings and PASV.
import os
diff -cr /tmp/Lib/getpass.py ./getpass.py
*** /tmp/Lib/getpass.py Tue Oct 19 00:25:22 1999
--- ./getpass.py Sun Feb 27 10:17:56 2000
***************
*** 6,14 ****
On Windows, the msvcrt module will be used.
On the Mac EasyDialogs.AskPassword is used, if available.
- Authors: Piers Lauder (original)
- Guido van Rossum (Windows support and cleanup)
"""
import sys
--- 6,15 ----
On Windows, the msvcrt module will be used.
On the Mac EasyDialogs.AskPassword is used, if available.
"""
+
+ # Authors: Piers Lauder (original)
+ # Guido van Rossum (Windows support and cleanup)
import sys
diff -cr /tmp/Lib/imaplib.py ./imaplib.py
*** /tmp/Lib/imaplib.py Thu Feb 24 03:24:50 2000
--- ./imaplib.py Sun Feb 27 10:18:53 2000
***************
*** 3,12 ****
Based on RFC 2060.
- Author: Piers Lauder <piers@cs.su.oz.au> December 1997.
-
- Authentication code contributed by Donn Cave <donn@u.washington.edu> June 1998.
-
Public class: IMAP4
Public variable: Debug
Public functions: Internaldate2tuple
--- 3,8 ----
***************
*** 14,19 ****
--- 10,19 ----
ParseFlags
Time2Internaldate
"""
+
+ # Author: Piers Lauder <piers@cs.su.oz.au> December 1997.
+ #
+ # Authentication code contributed by Donn Cave <donn@u.washington.edu> June 1998.
__version__ = "2.32"
diff -cr /tmp/Lib/poplib.py ./poplib.py
*** /tmp/Lib/poplib.py Thu May 13 20:47:25 1999
--- ./poplib.py Sun Feb 27 10:21:02 2000
***************
*** 1,11 ****
"""A POP3 client class.
Based on the J. Myers POP3 draft, Jan. 96
-
- Author: David Ascher <david_ascher@brown.edu>
- [heavily stealing from nntplib.py]
- Updated: Piers Lauder <piers@cs.su.oz.au> [Jul '97]
"""
# Example (see the test function at the end of this file)
--- 1,11 ----
"""A POP3 client class.
Based on the J. Myers POP3 draft, Jan. 96
"""
+
+ # Author: David Ascher <david_ascher@brown.edu>
+ # [heavily stealing from nntplib.py]
+ # Updated: Piers Lauder <piers@cs.su.oz.au> [Jul '97]
# Example (see the test function at the end of this file)
diff -cr /tmp/Lib/smtplib.py ./smtplib.py
*** /tmp/Lib/smtplib.py Fri Feb 4 16:39:30 2000
--- ./smtplib.py Sun Feb 27 10:12:15 2000
***************
*** 2,15 ****
"""SMTP/ESMTP client class.
- Author: The Dragon De Monsyne <dragondm@integral.org>
- ESMTP support, test code and doc fixes added by
- Eric S. Raymond <esr@thyrsus.com>
- Better RFC 821 compliance (MAIL and RCPT, and CRLF in data)
- by Carey Evans <c.evans@clear.net.nz>, for picky mail servers.
-
- This was modified from the Python 1.5 library HTTP lib.
-
This should follow RFC 821 (SMTP) and RFC 1869 (ESMTP).
Notes:
--- 2,7 ----
***************
*** 38,43 ****
--- 30,43 ----
(250, "Somebody OverHere <somebody@here.my.org>")
>>> s.quit()
"""
+
+ # Author: The Dragon De Monsyne <dragondm@integral.org>
+ # ESMTP support, test code and doc fixes added by
+ # Eric S. Raymond <esr@thyrsus.com>
+ # Better RFC 821 compliance (MAIL and RCPT, and CRLF in data)
+ # by Carey Evans <c.evans@clear.net.nz>, for picky mail servers.
+ #
+ # This was modified from the Python 1.5 library HTTP lib.
import socket
import string
diff -cr /tmp/Lib/telnetlib.py ./telnetlib.py
*** /tmp/Lib/telnetlib.py Thu Dec 24 00:04:17 1998
--- ./telnetlib.py Sun Feb 27 10:23:53 2000
***************
*** 1,7 ****
"""TELNET client class.
! Based on RFC 854: TELNET Protocol Specification, by J. Postel and
! J. Reynolds
Example:
--- 1,6 ----
"""TELNET client class.
! Based on RFC 854: TELNET Protocol Specification
Example:
***************
*** 35,40 ****
--- 34,40 ----
"""
+ # by J. Postel and J. Reynolds
# Imported modules
import sys
diff -cr /tmp/Lib/urlparse.py ./urlparse.py
*** /tmp/Lib/urlparse.py Fri Feb 4 16:28:42 2000
--- ./urlparse.py Sun Feb 27 10:25:20 2000
***************
*** 1,8 ****
"""Parse (absolute and relative) URLs.
! See RFC 1808: "Relative Uniform Resource Locators", by R. Fielding,
! UC Irvine, June 1995.
"""
# Standard/builtin Python modules
import string
--- 1,9 ----
"""Parse (absolute and relative) URLs.
! See RFC 1808: "Relative Uniform Resource Locators"
"""
+
+ # by R. Fielding, UC Irvine, June 1995.
# Standard/builtin Python modules
import string
diff -cr /tmp/Lib/whrandom.py ./whrandom.py
*** /tmp/Lib/whrandom.py Fri Feb 4 16:28:42 2000
--- ./whrandom.py Sun Feb 27 10:25:41 2000
***************
*** 25,34 ****
random generators, and to choose from other ranges.
- Translated by Guido van Rossum from C source provided by
- Adrian Baddeley.
-
-
Multi-threading note: the random number generator used here is not
thread-safe; it is possible that nearly simultaneous calls in
--- 25,30 ----
***************
*** 36,41 ****
--- 32,41 ----
have to use a lock around all calls. (I didn't want to slow this
down in the serial case by using a lock here.)
"""
+
+ # Translated by Guido van Rossum from C source provided by
+ # Adrian Baddeley.
+
class whrandom:
def __init__(self, x = 0, y = 0, z = 0):
--sm4nu43k4a2Rpi4c--