Commit Graph

3679 Commits

Author SHA1 Message Date
Fred Drake f3262b72ca Add entries for the doctest documentation. 2001-02-17 17:33:25 +00:00
Fred Drake 7eb1463bb3 Make a variety of minor markup adjustments.
Close some environments so that this will actually format.
2001-02-17 17:32:41 +00:00
Tim Peters 7688229f7c SF patch #103808: doctest.py docs
Checking in Moshe's patch after rewrapping some paragraphs (to consume
fewer columns) and repairing that I/2.**J lost the I.
2001-02-17 05:58:44 +00:00
Andrew M. Kuchling 30537da0ec Fix typo
Makefile.pre.in was added in 1.4
2001-02-17 00:42:56 +00:00
Andrew M. Kuchling da23c4fef9 Fix two typos, and add some omitted \option{} markup 2001-02-17 00:38:48 +00:00
Skip Montanaro 04f1d37471 mention the use of the maxtries attribute of FancyURLopener in bounding
redirection recursion.
2001-02-15 17:00:40 +00:00
Guido van Rossum bf416fa0dd Document default blocksize for storbinary(). 2001-02-15 13:53:40 +00:00
Fred Drake 523ec5709b Make some clarifications and corrections based on comments from Guido.
Fix a few markup nits.
Work around a LaTeX2HTML nuisance.
2001-02-15 05:37:51 +00:00
Fred Drake e4f1c3276a Be more careful to avoid spurious output from the shell script that
unpacks the development version of the docs on SF.
2001-02-14 21:26:31 +00:00
Fred Drake 8bcc4e8446 Commit this so CVS doesn't keep noticing the next version number. 2001-02-14 20:53:07 +00:00
Fred Drake 15862f50e5 Add a note to Node.isSameNode() that it is based on the DOM Level 3 working
draft.  I'm not sure that's important, but Uche thinks it is.
2001-02-14 20:39:15 +00:00
Fred Drake 1d8ad2b1de Updated to reflect the additional information and interfaces exported in
pyexpat.c revision 2.40.
2001-02-14 18:54:32 +00:00
Tim Peters 7530208d8b Feeble attempt to repair obsolete info about hex escapes. 2001-02-14 04:03:51 +00:00
Fred Drake 162c6a637a Reflect change in traceback format:
"innermost last" --> "most recent call last"
2001-02-14 03:20:18 +00:00
Andrew M. Kuchling 15ad28cf89 Finished the section on weak references
Mentioned doctest, difflib, sys._getframe(), and the change to use
   PyImport_ImportModule() everywhere in C code
No more XXX!
2001-02-14 02:44:18 +00:00
Andrew M. Kuchling e7d7e6c879 Fix two typos 2001-02-14 02:39:11 +00:00
Ka-Ping Yee 5401996638 Update to properly explain that the default Unicode encoding is ASCII, &c. 2001-02-13 22:20:22 +00:00
Fred Drake 498cb15306 Jon Nelson <jnelson@users.sourceforge.net>:
Make the documentation tools work with Python 1.5.2.
[Slightly modified from submitted patch. --FLD]

This closes SF bug #132005.
2001-02-12 19:12:55 +00:00
Fred Drake a05460c148 PyTuple_*() functions take PyObject* parameters, not PyTupleObject* values.
This closes SF bug #131304.
2001-02-12 17:38:18 +00:00
Fred Drake e38d481e77 Add a "description" meta tag that includes a version number. 2001-02-12 16:04:24 +00:00
Fred Drake b258bedb13 Jon Nelson <jnelson@users.sourceforge.net>:
Make the documentation tools compatibile with Python 2.0.
2001-02-12 15:30:22 +00:00
Andrew M. Kuchling 81b6ae7ef7 Create separate section for changes to the standard library
Make note about difflib and doctest
Bump version number
2001-02-11 16:55:39 +00:00
Fred Drake 5ed1dac4c0 Update documentation for pyexpat (xml.parsers.expat), to reflect the new
support for Expat 1.95.*.
2001-02-08 15:40:33 +00:00
Andrew M. Kuchling 6a360bd3a7 Wrote section on nested scopes, and moved it to the front
Began a section on weak references
Various rewrites and paragraph refills
Added: non-recursive makefiles, repr() of strings now uses \n, raw socket I/O
Bumped version number
2001-02-05 02:47:52 +00:00
Fred Drake 4e3f2752c5 Improve diagnostic output when an external command returns a non-zero exit
code, showing the transcript for that command.

This closes SF bug #129740.
2001-02-04 15:20:26 +00:00
Fred Drake cf2636696d Fix markup typo in a {verbatim} environment (there should not be any!);
caught by Eric Raymond.
2001-02-03 14:35:38 +00:00
Fred Drake 40e43bfaf7 Document Node.isSameNode(). 2001-02-03 01:20:01 +00:00
Fred Drake f891404e1a Move the whrandom section back to the documented modules section; this
gives people a chance to see the depracation notice.
2001-02-03 01:17:41 +00:00
Fred Drake 269625f67a Revise the deprecation note for the whrandom module to be correct and a
little more formal.
2001-02-03 01:12:44 +00:00
Fred Drake f0e08ef9cb Remove an now-false statement about there being only one type flag
defined.
2001-02-03 01:11:26 +00:00
Fred Drake 24da47708d Do not pass names of individual files to shutil.rmtree(); use os.unlink()
for that.
2001-02-02 15:48:00 +00:00
Fred Drake 6270031f4e Adjustments to the text of the UnixMailbox description. Added
PortableUnixMailbox as a separate class as well (this also generates
the right index entry).
2001-02-02 03:51:05 +00:00
Fred Drake 57d943ad38 Move the whrandom entry to the "Obsolete Modules" appendix. 2001-02-02 02:45:08 +00:00
Fred Drake 667c9e46ca Minor markup adjustments.
Move some index entries next to what they are referring to for better
"targetting".
2001-02-02 02:43:18 +00:00
Fred Drake 844bd5b4a9 Minor markup adjustments. 2001-02-02 02:42:31 +00:00
Fred Drake 68b6417c5a Added a warning at the top saying that user code should not use the
whrandom module directly.
2001-02-02 02:41:17 +00:00
Jeremy Hylton 3faa52ecc4 Allow 'continue' inside 'try' clause
SF patch 102989 by Thomas Wouters
2001-02-01 22:48:12 +00:00
Fred Drake d0946da701 Fix some markup breakage that prevented formatting; re-wrapped a couple of
wide paragraphs.
2001-02-01 15:53:24 +00:00
Fred Drake c2e35e6f37 Remove spurious "\end{description}" that caused formatting to fail. 2001-02-01 15:37:56 +00:00
Fred Drake 36154b2dbf Added entry for weakref documentation.
Moved commented-out entries for obsolete module to an appendix, still
commented out.
2001-02-01 05:21:46 +00:00
Fred Drake 0d0e64861b Add entry for weakref documentation. 2001-02-01 05:20:52 +00:00
Fred Drake ebcf6a8573 Documentation for the weakref module. 2001-02-01 05:20:20 +00:00
Tim Peters 0de88fc4b1 Change random.seed() so that it can get at the full range of possible
internal states.  Put the old .seed() (which could only get at about
the square root of the # of possibilities) under the new name .whseed(),
for bit-level compatibility with older versions.  This occurred to me
while reviewing effbot's book (he found himself stumbling over .seed()
more than once there ...).
2001-02-01 04:59:18 +00:00
Jeremy Hylton 0eb107068a update section 4.1 to describe nested scopes 2001-02-01 03:50:59 +00:00
Barry Warsaw 30dbd1429a Document the two changes to the mailbox.py module:
- All constructors grow an optional argument `factory' which is a
  callable used when new message instances are created by the next()
  methods.  Defaults to the rfc822.Message class.

- A new subclass of UnixMailbox is added, called PortableUnixMailbox.
  It's identical to UnixMailbox, but uses a more portable test for
  From_ delimiter lines.  With PortableUnixMailbox, any line that
  starts with "From " is considered a delimiter (this should really
  check for two newlines before the F, but it doesn't.
2001-01-31 22:14:01 +00:00
Barry Warsaw b416290d5d Some rewriting of the "Internationalizing your programs and modules"
subsection to include a discussion of the msgfmt.py program.
2001-01-31 21:21:45 +00:00
Fred Drake 5599441bbf Make HTML the default output format, since that is what people actually
want most of the time.
2001-01-30 22:30:01 +00:00
Jeremy Hylton 10f8ba4fc6 Remove note about the compiler not checking for two kinds of illegal
imports.  It checks for them now.
2001-01-30 01:25:15 +00:00
Andrew M. Kuchling 4308d3c4b5 Add note about non-recursive Makefiles
Get Fred's name right
Add some XXX items that need to be written
2001-01-29 17:36:53 +00:00
Eric S. Raymond 3229b859fb More on noutrefresh() and scroll(). 2001-01-29 06:39:33 +00:00
Skip Montanaro 4fda21ba6b updated to document use of sequences of two-element tuples as inputs 2001-01-28 21:18:16 +00:00
Fred Drake c37f5b3296 Adjust documentation for new.instance() to reflect that the second
parameter may be omitted or None.
2001-01-28 17:23:05 +00:00
Fred Drake 5838d0fc84 Document the PyInstance_*() functions and data. 2001-01-28 06:39:35 +00:00
Eric S. Raymond 9ca35ec97a Instructive example for strftime(); how to generate RFC822 dates. 2001-01-28 00:56:54 +00:00
Eric S. Raymond e7213c7a80 Emphasis that instantiating this class doesn't consume the message body.
Fix some unclear language in the description of the addrlist member.
2001-01-27 10:56:14 +00:00
Fred Drake 66f98b45cd Fix a number of typos found by Guido. 2001-01-26 20:51:32 +00:00
Fred Drake 8c071d4388 Massively improved documentation for string formatting operations,
primarily from Evelyn Mitchell (thanks!).

This closes SF patch #103412.
2001-01-26 20:48:35 +00:00
Fred Drake 2f4453af6a Typo: coplete --> complete
This closes SF bug #129759.
2001-01-26 15:27:35 +00:00
Tim Peters e360d9507a The combo of getstate/setstate/jumpahead is very powerful, but needs
examples to flesh it out for the uninitiated.  Here they are.
2001-01-26 10:00:39 +00:00
Fred Drake 8863460490 Add bzip2 archives back to the set of generated archives; we had way too
many reasonable requests to keep them around.

Bump version number.
2001-01-25 17:32:51 +00:00
Fred Drake 29052482d1 Removed references to Python 1.5.3; that was a "tentative" number I used
in the docs to indicate the next version before we decided on 1.6.

Adjusted winsound.Beep() description slightly as well.
2001-01-25 17:29:18 +00:00
Fred Drake cf069da57d Update link to LaTeX2HTML web site. 2001-01-25 17:25:28 +00:00
Tim Peters 517ce23183 Clarify winsound.beep docs, in response to c.l.py beep brouhahalet. 2001-01-25 09:33:48 +00:00
Tim Peters d52269bfd0 Fix bugs introduced by rewrite (in particular, time-based initialization
got broken).  Also added new method .jumpahead(N).  This finally gives us
a semi-decent answer to how Python's RNGs can be used safely and efficiently
in multithreaded programs (although it requires the user to use the new
machinery!).
2001-01-25 06:23:18 +00:00
Tim Peters d7b5e88e8e Reworked random.py so that it no longer depends on, and offers all the
functionality of, whrandom.py.  Also closes all the "XXX" todos in
random.py.  New frequently-requested functions/methods getstate() and
setstate().  All exported functions are now bound methods of a hidden
instance.  Killed all unintended exports.  Updated the docs.
FRED:  The more I fiddle the docs, the less I understand the exact
intended use of the \var, \code, \method tags.  Please review critically.
GUIDO:  See email.  I updated NEWS as if whrandom were deprecated; I
think it should be.
2001-01-25 03:36:26 +00:00
Barry Warsaw 83125775e0 A \begin{funcdesc} was closed with an \end{methoddesc}. 2001-01-25 00:39:16 +00:00
Barry Warsaw 21f37e1b88 Fixed a bug where \& was needed. 2001-01-25 00:38:15 +00:00
Barry Warsaw 8ee1a4bdeb Provide a much better (and complete!) description of the lockf()
function, based on an eyeballing of the code.
2001-01-25 00:36:54 +00:00
Tim Peters 902446a28d Supply long-missing docs for random.seed(). Extensive rewrite of module
intro docs.
*************** Fred:  check my LaTeX!  Also, the docs for whrandom should
*************** be moved into Obsolete Modules.
2001-01-24 23:06:53 +00:00
Fred Drake 9368a12011 Fix an obvious usage nit I should have caught myself on the previous
change to this file.  Thanks, /F!
2001-01-24 18:19:40 +00:00
Ka-Ping Yee fa004ad36c Show '\011', '\012', and '\015' as '\t', '\n', '\r' in strings.
Switch from octal escapes to hex escapes for other nonprintable characters.
2001-01-24 17:19:08 +00:00
Fred Drake 0bbaa515a1 Remove evil "sec:" prefix from some \label markups; this is bad for
filenames on Windows (& Mac?) platforms.
2001-01-24 16:39:35 +00:00
Fred Drake b1b6a11b28 AttributeList --> NamedNodeMap
Since there is no such thing as an AttributeList, don't say "attributes"
is one.
2001-01-24 16:17:15 +00:00
Fredrik Lundh 0110d3b2ad new unicodedata functions (name, lookup) 2001-01-24 08:10:07 +00:00
Skip Montanaro eda28445c0 documented (new) optional doseq parameter to urlencode. 2001-01-24 06:36:06 +00:00
Andrew M. Kuchling 1ae43c4341 Add names of people who've pointed out broken links and images
Bump version number
2001-01-24 01:11:26 +00:00
Andrew M. Kuchling d975196d57 Fredrik pointed out that the database shrank more than 55K 2001-01-24 00:52:56 +00:00
Andrew M. Kuchling 26e94a8822 Jeremy didn't write PEP 205, Fred did! 2001-01-23 15:21:05 +00:00
Eric S. Raymond f79cb2db3e Expose the autoraise capability. Improve the documentation. 2001-01-23 13:49:44 +00:00
Eric S. Raymond aeb5532ca0 Oops...finish a mangled sentence. 2001-01-23 13:22:28 +00:00
Eric S. Raymond f7f185116a Rewrite webbrowser.py to fix various bugs following Ka-Ping Yee's
complaints.  The new version moves most of its initialization to
package load time; it's simpler, faster, smaller, and adds support for
Mozilla and Links.  Interpretation of the BROWSER variable now works
and is documented.  The open_new entry point and methods are marked
"deprecated; may be removed in 2.1".
2001-01-23 13:16:32 +00:00
Andrew M. Kuchling f33c118869 Add introductory note about this article's draft status
Grammatical and typographic fixes from David Goodger
Expanded notes about PEP 229
Removed user-visible XXXes; they're in comments now
2001-01-23 02:48:26 +00:00
Fred Drake da6daee439 A variety of updates of out-of-date information. 2001-01-22 21:38:09 +00:00
Fred Drake bc3974c03b When generating the source package, copy in the LICENSE file from the main
source directory.
2001-01-22 21:34:20 +00:00
Fred Drake 9c3b9b76c1 Never mind ignoring a copied LICENSE file; let's do this another way. 2001-01-22 21:31:38 +00:00
Fred Drake e94b9f9d3c Ignore the generated LICENSE file needed for the documentation source
package.
2001-01-22 21:07:36 +00:00
Fred Drake 3a045e8993 Change the main targets to generate HTML instead of PostScript.
Update the comments at the beginning of the file.
2001-01-22 20:47:26 +00:00
Fred Drake dc40ac0fe0 Added link to the "Python Codecs" project at SourceForge.
Changed markup of the list of values for the list of meaningful "errors"
values.
2001-01-22 20:17:54 +00:00
Andrew M. Kuchling 91834c6c7e Added dictionary.popitem() and the improved XML modules.
Reorder the smaller items, roughly in decreasing order of visibility to
   the Python coder
Finished an incomplete sentence.
Moved the unwritten sections down to the bottom.
Bumped version number and added acknowledgements
2001-01-22 19:51:13 +00:00
Fred Drake 0f564eaceb Change some wording to make this work with PDF generation -- using a PDF
hyperlink at the start of the paragraph confused pdflatex; it saw the
link start while still in vertical mode, which is not allowed.  Including
text before the link forces horizontal mode.
2001-01-22 19:06:20 +00:00
Fred Drake bcb09fa33f Worked around bug SF #125880: changed the text of three sections that
really nasty TeX source to "bleed" into the PDF "bookmarks".
2001-01-22 18:38:00 +00:00
Fred Drake 5f0decf0d3 Clean up the docs for the "random" module according to comments from Tim
Peters.

This closes SF bug #125919.
2001-01-22 18:18:30 +00:00
Andrew M. Kuchling f228fd10d9 Add reference to PEP 232.
Use correct flag name Py_TPFLAGS_CHECKTYPES
Mention that numeric methods can return Py_NotImplemented (NAS)
Mention optional arguments in time modules (TW)
Various minor rewrites and additional attributions
2001-01-22 17:52:19 +00:00
Fred Drake 31ab298df6 Remove the dollar sign from the formatting of environment variables --
too Unix-specific, and not really needed.  (Already fixed the HTML
formatting, but forgot to mention it in the checkin for python.perl 1.94.)
2001-01-22 17:50:42 +00:00
Fred Drake 0a8690a0ad Make "PythonLabs" bold. 2001-01-22 17:48:23 +00:00
Fred Drake c8e8281fb6 Updated note about collection of cyclic garbage, based on comments from
Chris Ryland.
2001-01-22 17:46:18 +00:00
Fred Drake ef8cd7ca99 Minor markup adjustment. 2001-01-22 17:42:32 +00:00
Fred Drake afc7ce118e Fix \seepep handling -- correct URL to the online PEP repository on SF is
now generated.  (SF bug #129692.)

Patch from Anthon van der Neut <anthon@mnt.org>:
Work around the removal of content-less paired tags used for name
anchors in some places.  (SF bug #116008.)

Move some class attributes from an artificial SPAN element to otherwise
"useful" elements that are being generated anyway.  Added the class
"versionnote", used for \deprecated, \versionadded, \versionchanged.
2001-01-22 17:33:24 +00:00
Andrew M. Kuchling b216ab632f Fill out various transcripts and XXX bits, thanks to the WMATA.
The only missing section is the Nested Scopes section, which has to wait
    to see if a patch is actually committed.  (Plus any other notable changes
    that get made or backed out between now and 2.1final, of course...)
2001-01-22 16:15:44 +00:00
Andrew M. Kuchling 90cecee894 Beginning of a "What's New in Python 2.1" article 2001-01-22 04:02:09 +00:00