Commit Graph

6353 Commits

Author SHA1 Message Date
Andrew M. Kuchling 68a3294fc4 [Bug #779469] Fix error in example code 2003-07-30 11:55:06 +00:00
Fred Drake 9d843087b6 update the documentation contact address 2003-07-30 02:55:28 +00:00
Fred Drake 333d6fd583 - update the documentation contact address
- remove text about the long-moved Mac OS libref chapter
2003-07-30 02:55:01 +00:00
Andrew M. Kuchling b34ba3f174 Bump version number; record 2.3 release date 2003-07-29 12:06:32 +00:00
Fred Drake 7a7aba9931 Update release information. 2003-07-29 03:20:32 +00:00
Fred Drake 96b49ffbe2 Bump version information. 2003-07-29 03:11:34 +00:00
Fred Drake d50bd6cf00 Update URL. 2003-07-28 14:39:13 +00:00
Fred Drake 98741af170 Bump release number. 2003-07-24 01:22:50 +00:00
Fred Drake a3788642a3 Fix representation of ^= operator in __ixor__() documentation.
Closes SF bug #776181.  Should be backported.
2003-07-23 15:18:03 +00:00
Raymond Hettinger 88821f7c20 Important usability fix in itertools documentation. 2003-07-22 06:33:13 +00:00
Fred Drake f1c9869ab0 Avoid a 301 permanent redirect.
Part of SF patch #773007.

Also fixed a number of mostly cosmetic markup errors.
2003-07-22 01:09:22 +00:00
Fred Drake 644a08c735 Avoid a 301 permanent redirect.
Part of SF patch #773007.
2003-07-22 01:09:22 +00:00
Fred Drake 700c890631 Avoid a few 301 permanent redirects.
Part of SF patch #773007.
2003-07-22 00:52:42 +00:00
Fred Drake ef13949e00 Avoid a 301 permanent redirect.
Part of SF patch #773007.
2003-07-22 00:49:11 +00:00
Fred Drake 6c4970995a Merge the old dumbdbm documetation into the new docs that have been added.
Make some module references hyperlinks.
2003-07-21 15:30:15 +00:00
Andrew M. Kuchling 0ceb9b1603 Change \code to \verb, because TeX merges the two dashes into a
hyphen, resulting in the output '-list-classifiers', not the correct
'--list-classifiers'.  I've verified that the line is now correct
in the DVI, PDF, HTML, and ASCII versions.
2003-07-21 12:49:46 +00:00
Raymond Hettinger 476fcae4d7 SF bug #774411: Typo in socket documentation 2003-07-20 01:10:15 +00:00
Andrew M. Kuchling 95be8bdab7 Add introductory paragraphs
Remove comment about MacOS changes; I'm not going to have time to figure
    out what they are
Move PEP 273 section into numeric order
2003-07-18 02:12:16 +00:00
Andrew M. Kuchling 6e73f9e5db Add a few more items 2003-07-18 01:15:51 +00:00
Andrew M. Kuchling 8744f12a2f Complete the rewrite pass; add a few more items; bump version number to 0.90; remove comment about draft status 2003-07-17 23:56:58 +00:00
Fred Drake 7a6b4f0284 more markup chages 2003-07-17 16:00:01 +00:00
Fred Drake 0106e1dd20 Include the GNU info format in the edist target since we're now
building a fair portion of the documentation as info.
2003-07-17 15:29:16 +00:00
Fred Drake 8836e567b9 - remove mention of the isprivate flag, since that isn't directly
documented here, and according to Tim, should never have been there
- misc. cleanups for consistency
2003-07-17 15:22:47 +00:00
Raymond Hettinger 943277ecd3 Minor corrections. 2003-07-17 14:47:12 +00:00
Fred Drake de7cdb26d1 - put the GNU info packages in the same place as everything else
- add a convenience target to create the package list directly
2003-07-17 11:55:18 +00:00
Fred Drake e5f15ff8cb - update the list of documents for which GNU info is built
- convert tabs to spaces
2003-07-17 05:36:19 +00:00
Fred Drake 7262ca8abf Bump version numbers. 2003-07-17 05:30:38 +00:00
Fred Drake ea690c4b25 - improve the description of how user-defined method
objects get made
  - improve the description of attribute retrieval from
    classes and class instances
  - add brief documentation of static method and
    class method objects.
2003-07-17 05:26:53 +00:00
Fred Drake 38d7c1bb78 Note that Unicode strings are now supported in sys.path.
SF patch #764594.
2003-07-17 04:22:44 +00:00
Fred Drake e8e241b732 Make the howto document class work properly with the pypaper.sty
paper-size hook.
SF patch #772550.
2003-07-17 04:15:35 +00:00
Skip Montanaro bfa6872260 Zap the C API subsection altogether for now. It's not actually usable from
C yet anyway.
2003-07-16 21:14:35 +00:00
Andrew M. Kuchling aa9b39f910 Mention list.index; more small textual changes 2003-07-16 20:37:26 +00:00
Andrew M. Kuchling c760c6c442 Add reminder list of things to document; mention sys.getcheckinterval() and socket.timeout exception 2003-07-16 20:12:33 +00:00
Skip Montanaro 2491cd98c4 expose the C API subsection which was hidden from LaTeX in a comment. In
the info conversion the \comment LaTeX macro mapped to a Texinfo @ignore
macro.  Unfortunately, py2texi.el is not smart enough to avoid generating
links to the @ignore'd section, which causes makeinfo to croak.

Exposing this text is probably not the most correct thing to do, as this
documentation really belongs in the C API manual.  This does get the info
files generated, however, which is a more practical goal considering the
impending release of 2.3rc1.
2003-07-16 19:46:07 +00:00
Raymond Hettinger 4d6e8fe5d1 Clarify the lack of relationship between rich comparison operators.
Prompted by a discussion on comp.lang.python.
2003-07-16 19:40:23 +00:00
Raymond Hettinger 71adf7e9d8 Doctest now examines all docstrings by default. Previously, it would
skip over functions with private names (as indicated by the underscore
naming convention).  The old default created too much of a risk that
user tests were being skipped inadvertently.  Note, this change could
break code in the unlikely case that someone had intentionally put
failing tests in the docstrings of private functions.  The breakage
is easily fixable by specifying the old behavior when calling testmod()
or Tester().  The more likely case is that the silent failure was
unintended and that the user needed to be informed so the test could be
fixed.
2003-07-16 19:25:22 +00:00
Fred Drake 853276e16d Lots of markup cleanups to avoid warnings from the GNU info generation;
these make sense even without that processing chain.
2003-07-16 17:58:38 +00:00
Fred Drake 788617f8f0 Remove \versionchanged; the text was too complex for the GNU info
conversion to support.  Keep the content as normal content, with a
note that this applies starting in Python 2.3.
2003-07-16 16:19:08 +00:00
Andrew M. Kuchling 2cd773160d Minor text changes; update bug/patch count (quite a jump!) 2003-07-16 14:44:12 +00:00
Fred Drake bd5fdd93a9 Make it easier to figure out the where a menuselection starts and ends
by controling the font.
2003-07-16 14:01:56 +00:00
Fred Drake a66b6c1267 Cygwin instructions:
- added missing period
- added markup so it's easier to tell which names are special
2003-07-16 13:50:28 +00:00
Fred Drake d24c767d5b A variety of markup-level adjustments. 2003-07-16 05:17:23 +00:00
Raymond Hettinger 46f681cc07 Discussion of signatures for unicode.translate() and str.translate()
were in the wrong file.  Moved out of libstring.tex and into
libstdtypes.tex.
2003-07-16 05:11:27 +00:00
Fred Drake 6c85bcb2aa - update some comments
- add support for the "What's New" document
- add short aliases for individual documents; nice for debugging
  conversions
2003-07-16 04:02:58 +00:00
Fred Drake fa00f91897 Pass along the selected "What's New" document to the make file for the
GNU info conversion.
2003-07-16 04:01:04 +00:00
Fred Drake 15b3dba85e Adjust description of the internationalized domain name encoding to
better accomodate the GNU info conversion.
2003-07-16 04:00:14 +00:00
Fred Drake 0bb242b67c Map \envvar to the TeXinfo equivalent, @env. 2003-07-16 03:44:48 +00:00
Fred Drake 850026308b Simple support for the alltt environment. 2003-07-16 03:35:41 +00:00
Fred Drake 3605ae5966 In the description of enumerate(), the indexing operators should not
be included in the \var.  This produced weird results in general, but
broke the GNU info conversion.
2003-07-16 03:26:31 +00:00
Fred Drake 7769bb9224 Teach this script about \AA and \aa (the Scandanavian A-ring
characters); \AA is used in whatsnew23.tex.
2003-07-16 03:16:34 +00:00
Raymond Hettinger b233e54409 Nits. 2003-07-15 23:16:01 +00:00
Fred Drake d51ce7de97 Indexing is a mess; try to get the link targets closer to the relevant
text.  There needs to be a better way.
2003-07-15 22:03:00 +00:00
Fred Drake 4e72e0533d process_commands_wrap_deferred:
- fix comment describing what this is for
  - add lots of indexing macros to this call
Closes SF bug #518989.
2003-07-15 22:00:36 +00:00
Fred Drake b3be52eaf4 Try to clean up some indexing relevant to the import statement.
Pertains to SF bug #518989.
2003-07-15 21:37:58 +00:00
Fred Drake e37b4ed24e Discuss calling new-style types.
Closes SF bug #453683.
2003-07-15 20:45:16 +00:00
Fred Drake d9cf8e7e7c Markup consistency nits. 2003-07-14 21:07:05 +00:00
Fred Drake 9753ae1237 Added missing markup. 2003-07-14 20:53:57 +00:00
Raymond Hettinger 708c2a877e Fix unbalanced parenthesis in text. 2003-07-14 18:36:47 +00:00
Raymond Hettinger 0e53d234eb Fix missing parenthesis 2003-07-14 18:24:26 +00:00
Skip Montanaro 7233117960 update norobots link 2003-07-14 17:04:50 +00:00
Skip Montanaro a2d3d93ee3 + libdumdbm 2003-07-14 12:13:27 +00:00
Skip Montanaro 0f59b54f32 + libdumbdbm 2003-07-14 12:12:56 +00:00
Skip Montanaro d54c5ddd28 minimal dumdbm module doc 2003-07-14 12:12:37 +00:00
Raymond Hettinger 9bb33868af SF bug #738090: Section 13.3: htmllib.HTMLParser constructor definition
amendment

Add a clarifying cross-reference to the formatter module.
2003-07-14 08:15:47 +00:00
Raymond Hettinger 5c5fca9844 SF bug #706546: u''.translate not documented
Clarified the difference between translate methods for string objects and
Unicode objects.
2003-07-13 02:06:47 +00:00
Raymond Hettinger 627273733f SF bug #770107: Typo in documentation of resource module 2003-07-13 00:46:40 +00:00
Martin v. Löwis 162f081fb3 Patch 549151, rev4: redirect posts for 301 also. Will backport to 2.2. 2003-07-12 07:33:32 +00:00
Raymond Hettinger a685f52256 Fix missing parenthesis 2003-07-12 04:42:30 +00:00
Raymond Hettinger 6122d0267f SF patch #726751: Clarify docs for except target assignment
Brett found that the tutorial didn't really explain what was happening
with exception targets.  Hopefully, this sheds some light on the subject.
2003-07-12 01:05:37 +00:00
Raymond Hettinger 92f21b13ea Document Jim Fulton's docttest extensions. 2003-07-11 22:32:18 +00:00
Raymond Hettinger fa6cce1fdd Minor fixups and added sections for iterators and generators. 2003-07-11 18:58:11 +00:00
Fred Drake e7f343d0f1 normalize whitespace 2003-07-11 03:36:15 +00:00
Fred Drake 192b95bb6c update the reference to the Apple Publications Style Guide 2003-07-11 03:34:17 +00:00
Raymond Hettinger 9de3c21865 SF #767592: unittest docs don't suggest "unittest.main()"
Expanded docs to have a quick start example showing how
to create and run tests.
2003-07-10 22:14:41 +00:00
Fred Drake 7adcfad4c2 fix stupid typo 2003-07-10 17:04:45 +00:00
Raymond Hettinger 8ccf4d751d Missing markup. 2003-07-10 15:48:33 +00:00
Neal Norwitz a4d2b869b9 Add versionadded. Remove duplicate "to" 2003-07-09 12:41:55 +00:00
Kurt B. Kaiser 39c3bdc022 Adding "use warnings" to .../Doc/perl/python.perl raises
the Perl requirement to 5.6.0 or later.
2003-07-08 18:05:26 +00:00
Kurt B. Kaiser 0b1782f7c0 Document interrupt_main()
Remove obsolete reference to deprecated exit_thread() function
2003-07-08 17:07:20 +00:00
Neal Norwitz dd3afa75b3 add missing ' 2003-07-08 16:26:34 +00:00
Fred Drake 7898ccdd63 Improve compatibility with more versions of LaTeX2HTML and more LaTeX
markup.  Not currently needed, but easier to save this now than to
have to figure it out when we do.
2003-07-08 15:57:52 +00:00
Fred Drake 9a5b6a6f08 - clean up table markup for readability
- don't use \constant for literals; it's for "defined" constants
- fix various consistency issues
2003-07-08 15:38:40 +00:00
Fred Drake 8120995b56 Update Tkinter3000 notes based on text from Fredrik Lundh. 2003-07-08 13:44:27 +00:00
Anthony Baxter a6b7d3411f Fixed a table that wasn't in a tableii block, and added a very simple
example to show how to log to a file.
2003-07-08 08:40:20 +00:00
Fred Drake dfda8d79ee - explain about making Python scripts executable on Unix in more
detail
- fix minor markup nit
2003-07-07 21:00:29 +00:00
Fred Drake b93b3e790e Error noted in email to python-docs: PyObject corresponds to
PyObject_HEAD, not PyObject_VAR_HEAD.
2003-07-07 17:20:40 +00:00
Neal Norwitz 7cb229df18 add versionadded for getcheckinterval 2003-07-07 14:11:53 +00:00
Tim Peters e5e065b669 New function sys.getcheckinterval(), to complement setcheckinterval(). 2003-07-06 18:36:54 +00:00
Neal Norwitz b25229d823 Fix SF bug #766288, property() example gives syntax error 2003-07-05 17:37:58 +00:00
Skip Montanaro eec26f982a Correct documentation of check interval - it's 100 by default, not 10 any
longer.  Pointed out by Alex Martelli.
2003-07-02 21:38:34 +00:00
Skip Montanaro 5e4e39f12a Note that csv files (when they are actual files) must be opened in 'b'inary
mode.  Note that the only restriction on the csvfile passed to writer
objects is that it have a write method.
2003-07-02 15:32:48 +00:00
Raymond Hettinger 774816f817 SF bug #764616: execfile(filename,...) not execfile(file,...)
Clarify parameter name.
2003-07-02 15:31:54 +00:00
Raymond Hettinger f8020e0211 Grammar nit. SF bug #757822 2003-07-02 15:10:38 +00:00
Fred Drake c5528b1f5c Revert the previous change; this is now dealt with in a better way. 2003-07-02 14:44:55 +00:00
Fred Drake 6675881aab There's a better way to deal with the "comment" environment; I found
this in SF patch #732174.
2003-07-02 14:44:08 +00:00
Fred Drake 629dd99802 Make the "install schema" tables follow the same table style we use
elsewhere (lines between columns).
2003-07-02 14:33:11 +00:00
Fred Drake 89de74ee94 The Macintosh Modules Reference now formats to GNU info without errors
(which is not to say it's right), so re-enable it.

Documenting Python and Installing Python Modules still have problems
when converting to GNU info, so we'll continue to leave them out for
now.
2003-07-02 14:25:04 +00:00
Fred Drake 3b09558710 Fill out the set of macros and environments supported somewhat.
Some of this is still pretty iffy.
2003-07-02 14:22:48 +00:00
Fred Drake 1ec0bdf899 The datetime C API really isn't usable outside the datetime module
implementation, so remove this decoy (it break formatting of the GNU
info version of the docs).
2003-07-02 13:42:51 +00:00
Fred Drake 2884d6de15 Fix a variety of small markup nits. 2003-07-02 12:27:43 +00:00
Fred Drake 3ede7848a9 - note that super() only applies to new-style classes;
closes SF bug #764003
- fix markup for consistency
2003-07-01 16:31:26 +00:00
Fred Drake 901a41e757 normalize markup for consistency 2003-07-01 16:17:50 +00:00
Tim Peters 93ceaea01f showwarning() calls formatwarning(), not showwarning().
Bugfix candidate.
2003-07-01 14:37:59 +00:00
Raymond Hettinger 9c8f78deab Improve the wording a bit 2003-07-01 07:19:17 +00:00
Raymond Hettinger 69d6356eb9 Fix spelling, grammar, usage, and markup. 2003-07-01 06:29:18 +00:00
Raymond Hettinger 8ee006097f SF #751062: Tutorial: remove string exceptions, add parnassus, #posts
(Contributed by Gerritt Holl)

* Remove the last mentions of string exceptions
* Reference a third-party repository of programs
* Minor clarification of comp.lang.py posting volumes
2003-07-01 06:19:34 +00:00
Brett Cannon 20def8bb19 Make temporary change of using _strptime for time.strptime permanent.
Flesh out docs to better explain time.strptime (closes bug #697990).
2003-07-01 05:16:08 +00:00
Neal Norwitz ecc7171007 Add versionadded info for the 2 new threading module functions 2003-06-30 21:47:47 +00:00
Thomas Heller 675580f4fc Document the DISTUTILS_DEBUG variable.
Closes sf #761401.

Backport candidate.
2003-06-30 19:33:29 +00:00
Fred Drake 220e83946d We are now post-beta 2. 2003-06-30 13:38:38 +00:00
Fred Drake f647b63624 Added missing name (textwrap.dedent() docs). 2003-06-30 12:18:52 +00:00
Raymond Hettinger ccd615c1a7 SF bug #762990: Awful Grammar in Python Tutorial
Fixed a nit.
2003-06-30 04:27:31 +00:00
Fred Drake 5728815e7b Fix broken markup, & tweak a couple of things for consistency. 2003-06-29 18:12:23 +00:00
Jeremy Hylton bfccb35b58 Add settrace() and setprofile() functions to the threading library. 2003-06-29 16:58:41 +00:00
Fred Drake 85d27576a3 Update copyright years. 2003-06-29 16:55:47 +00:00
Skip Montanaro 32a5e878d7 minor wordsmithing 2003-06-29 16:01:51 +00:00
Raymond Hettinger be2528d866 SF patch #760257: add socket.timeout exception
(Contributed by Bob Halley)

Add documentation for the new socket.timeout exception.
2003-06-29 04:55:59 +00:00
Raymond Hettinger 5918f8de67 Minor fixes to punctuation and grammar. 2003-06-29 04:53:23 +00:00
Fred Drake 3e2244c9e1 Bump version information for Python 2.3 beta 2. 2003-06-29 02:17:28 +00:00
Fred Drake 6595e15331 Document PyThreadState_SetAsyncExc(). 2003-06-29 02:14:31 +00:00
Barry Warsaw 6891cd3aa3 A few minor improvements 2003-06-28 15:22:16 +00:00
Jim Fulton 6c71091fbe Rewrote the docs for supporting cyclic garbage collection to reflect
the new way that once writes types.

Deleted the old section and sample code and added a new section
building on the Noddy example.
2003-06-28 13:29:16 +00:00
Jim Fulton 9c3e957251 Updated the depenencies to reflect changes in the sample code for
building new types.
2003-06-28 13:27:57 +00:00
Jim Fulton 18a6be9748 Added tests for sample modules. 2003-06-28 11:54:40 +00:00
Jim Fulton f0e38d1cd2 Added s setup module to make it easier to test the sample modules. 2003-06-28 11:54:20 +00:00
Jim Fulton 7050e929e6 Fixed bug in implementation of tp_init function. It should be an int
function, not a PyObject *.
2003-06-28 11:54:03 +00:00
Jim Fulton 4b59f9165d Changed the assignment of PyType_GenericNew to tp_new slot. Now do
this in module initialization before calling PyType_Ready.  (Sorry
Tim.) This is necessary to compile on cygwin.  AFAIK, we support
cygwin. If so, then we need to write extentions this way.
2003-06-28 11:53:29 +00:00
Jim Fulton db6a569de7 Changed the assignment of PyType_GenericNew to tp_new slot. Now do
this in module initialization before calling PyType_Ready.  (Sorry
Tim.) This is necessary to compile on cygwin.  AFAIK, we support
cygwin. If so, then we need to write extentions this way.

Fixed bug in implementation of tp_init function. It should be an int
function, not a PyObject *.
2003-06-28 11:53:12 +00:00
Fred Drake ded8e740df Correct markup errors that prevented formatting. 2003-06-28 11:50:34 +00:00
Martin v. Löwis 7928f388c4 Explain source encodings. Fixes #683486. 2003-06-28 08:11:55 +00:00
Raymond Hettinger 3567a876c7 Add take() to examples. Tighten the islice() example 2003-06-28 05:44:36 +00:00
Fred Drake 5d2f515dd4 fix markup nits 2003-06-28 03:09:06 +00:00
Raymond Hettinger 6f3eaa67e5 SF patch #761519: Fixes for bugs 760703 and 757821
SF bug #760703: SocketHandler and LogRecord don't work well together
SF bug #757821: logging module docs

Applied Vinay Sajip's patch with a few minor fixups and a NEWS item.

Patched __init__.py - added new function
makeLogRecord (for bug report 760703).

Patched handlers.py - updated some docstrings and
deleted some old commented-out code.

Patched test_logging.py to make use of makeLogRecord.

Patched liblogging.tex to fill documentation gaps (both
760703 and bug 757821).
2003-06-27 21:43:39 +00:00
Tim Peters 6ebe61fa80 A hack to ease compatibility with pre-2.3 Pythons: by default, doctest
now accepts "True" when a test expects "1", and similarly for "False"
versus "0".  This is un-doctest-like, but on balance makes it much
more pleasant to write doctests that pass under 2.2 and 2.3.  I expect
it to go away again, when 2.2 is forgotten.  In the meantime, there's
a new doctest module constant that can be passed to a new optional
argument, if you want to turn this behavior off.

Note that this substitution is very simple-minded:  the expected and
actual outputs have to consist of single tokens.  No attempt is made,
e.g., to accept [True, False] when a test expects [1, 0].  This is a
simple hack for simple tests, and I intend to keep it that way.
2003-06-27 20:48:05 +00:00
Fred Drake 095f817330 Don't assume the name of the table of contents will be contents.html;
that won't be right when mkhowto is called with --numeric (as it is
for the Python Tutorial).  Save the actual name we use when we build
the table of contents, then use that in the page head metadata.  The
node2label.pl script will munge this properly when --numeric isn't
given, so this works in both cases.
Closes SF bug #761830.
2003-06-27 18:26:01 +00:00
Fred Drake 25b5358cf2 Add definitions of the test and testlist symbols in the grammar so
there are no gaps in the definitions.
Closes SF bug #726150.
2003-06-27 17:12:43 +00:00
Fred Drake 6ab8b40337 fix link-hovering so <a name='...'> (no href attribute) doesn't get
the hovering background
2003-06-27 16:32:27 +00:00
Raymond Hettinger df9eff061e * Markup nits for the Invoking Descriptors section
* Documented __slots__
* Documented __metaclass__

Shamelessly plagarized from Guido's tutorial.
2003-06-27 06:57:56 +00:00
Raymond Hettinger d0cda1dc9f SF patch #760792: "wo" in "word" now valid but not documented as such
Revised version of a contribution from Gerrit Holl.

Update the docs for the extended behavior of __contains__
2003-06-26 19:32:10 +00:00
Raymond Hettinger daa340418b * Fixed an unmatched parenthesis early in the text.
* Clarified the meaning of lexicographic sequence ordering as discussed on
  comp.lang.python:  http://groups.google.com/groups?th=e163c9f9ba114493
2003-06-26 17:41:40 +00:00
Fred Drake f91888bb46 markup consistency nits 2003-06-26 03:11:57 +00:00
Fred Drake 4db3661e24 remove _ from label: LaTeX rejects this due to all the magic we use to
get the _ character to format like a normal character
2003-06-26 03:11:20 +00:00
Raymond Hettinger 2b9bc08ee7 Removed useless intra-section references which jump to the top of the
section instead of the specific item being referenced.
2003-06-25 20:36:20 +00:00
Raymond Hettinger 2dd8c42638 SF bug #696777: How to make a class iterable using a member generator.
* Added a note that a container class can implement the iterator protocol
  by defining its __iter__() method as a generator.
2003-06-25 19:03:22 +00:00
Raymond Hettinger 03ec6d538a * Document how descriptors are invoked.
* Fix minor parenthesis matching errors in ref3.tex.
2003-06-25 18:29:36 +00:00
Raymond Hettinger 35fd926195 SF bug #757822: Additional index items, other minor details
* Minor grammatical fix.
2003-06-25 15:07:45 +00:00
Martin v. Löwis 9e9a7c3dd7 Patch #640236: Better eplain unused data. 2003-06-21 14:15:25 +00:00
Martin v. Löwis 171be76bdd Patch #755683: Document that there might be a maximum indentation limit.
Fixes #700827
2003-06-21 13:40:02 +00:00
Barry Warsaw 47db252786 Add some documentation which describes how to use the email package
instead of rfc822 as the Message factory.
2003-06-20 22:04:03 +00:00
Neal Norwitz 3a03de4a27 SF #757229, fix libsocket.tex typo 2003-06-20 17:11:39 +00:00
Fred Drake 2664cbbeba Remove heading from orphan section. 2003-06-20 14:27:27 +00:00
Fred Drake 0799d0a9e3 Update link to Python book information. 2003-06-20 14:00:49 +00:00
Skip Montanaro f5ed9819b0 Avoid using 'dir' as a variable name and use os.path.join() to create
paths.
2003-06-19 18:10:37 +00:00
Raymond Hettinger befa37dd05 Minor updates:
* Updated comment on design of imap()
* Added untraversed object in izip() structure
* Replaced the pairwise() example with a more general window() example
2003-06-18 19:25:37 +00:00
Fred Drake 3a8fbe7eec Include "instances of most classes" in a warning about mutable objects
as default values of function/method parameters.
2003-06-18 17:14:29 +00:00
Raymond Hettinger b5155e30ce Fix typo. 2003-06-18 01:58:31 +00:00
Raymond Hettinger 96a8233b64 SF patch #751038 fixing SF bug#750092: exec doesn't need newline
Patch contributed by Steven Taschuk.
2003-06-18 01:32:24 +00:00
Walter Dörwald 93719b56ed Updated documentation for the new slice arguments for list.index(). 2003-06-17 16:19:56 +00:00
Skip Montanaro 364ca40c2a SF Patch 569574 - enhancements to cgitb for plain text display 2003-06-17 12:58:31 +00:00
Neal Norwitz 938b7a0f63 Fix some markup nits 2003-06-17 02:37:06 +00:00
Tim Peters 9ca3f02dc0 ^D means EOF on Unix but not on Windows. Expand the example's prompt to
tell Windows Truth too.

Bugfix candidate.
2003-06-15 23:08:45 +00:00
Brett Cannon 9e6fedd2ec Add explicit text for where an obindex call for generators was since obindex does not cause output of its argument. 2003-06-15 22:57:44 +00:00
Jack Jansen 097da0dc01 Documented the fact that the main class now mimicks the OSA "application" class. 2003-06-13 14:59:26 +00:00
Raymond Hettinger 7e902b27e0 * Added missing documentation for object().
* Noted the Py2.3 in the optional arg for bool().
2003-06-11 09:15:26 +00:00
Raymond Hettinger 3985df2c99 SF bug #660022: parameters for int(), str(), etc.
* Indicate that arguments are optional for most builtin type constructors.
* Replace e.g. in staticmethod() and classmethod() docs.
* Add \code{} markup to some in-line code examples.
2003-06-11 08:16:06 +00:00
Raymond Hettinger 132fa373d1 Add docs for get_grouped_opcodes(). 2003-06-11 07:50:44 +00:00
Raymond Hettinger 80b3f685b4 SF bug: 751941 Invisible HTML tag
Added missing jump target labels.
2003-06-10 21:41:22 +00:00
Barry Warsaw 9caa0d1642 guess_all_extensions(): Return the empty list instead of None when
there are no matching types.  Updated the docs and docstrings.  Added
some unit tests.
2003-06-09 22:27:41 +00:00
Raymond Hettinger e07b83591f Document context_diff() and unified_diff() 2003-06-09 21:44:59 +00:00
Neal Norwitz 305908cffd SF #735051, add time.tzset documentation 2003-06-08 13:57:19 +00:00
Gustavo Niemeyer 9556fba685 - urllib2.py now knows how to order proxy classes, so the user doesn't
have to insert it in front of other classes, nor do dirty tricks like
  inserting a "dummy" HTTPHandler after a ProxyHandler when building an
  opener with proxy support.
2003-06-07 17:53:08 +00:00
Raymond Hettinger b268f03459 SF bug #749759: comparisons yield bool not int
Minor documentation fix.
2003-06-06 02:52:14 +00:00
Skip Montanaro a1045567e0 QUOTE_ALWAYS -> QUOTE_ALL 2003-06-04 15:30:13 +00:00
Martin v. Löwis 19a5a710fc Patch #744238: Explain that different string types also may compare equal. 2003-05-31 08:05:49 +00:00
Martin v. Löwis 7472336444 Patch #744877: Explain filter in terms of list comprehension. Remove
explanation of int in terms of string.atoi. Explain sum in terms of
reduce.
2003-05-31 08:02:38 +00:00
Fred Drake d691c42a38 Include both </tr> tags in the thead, not just the first. 2003-05-29 19:46:29 +00:00
Neal Norwitz 847207acff SF bug #719367, string exceptions are deprecated
Remove references to string based exceptions in the doc.
2003-05-29 02:17:23 +00:00
Neal Norwitz d3d5768e5e isdatadescriptor() was added recently. 2003-05-29 02:10:31 +00:00
Greg Ward 2748a4aa7e Typo fix. 2003-05-29 01:41:51 +00:00
Greg Ward fb1b5a164d Rewrite the description of setparameters() so it actually reflects the
code (which has also been recently overhauled, so that it can be
documented without embarassment).

'error' has been renamed to 'OSSAudioError'.

Minor wordsmithing.
2003-05-29 01:39:32 +00:00
Gregory P. Smith dad58601a0 Remove the note about the BerkeleyDB license. Barry indicates that
sleepycat has told him that since python is OSS and berkeleydb is
being distributed with python for the bsddb library all is fine.
2003-05-28 16:20:03 +00:00
Jeremy Hylton a95d3b78c8 Oops. License is still an appendix. 2003-05-28 12:12:55 +00:00
Jeremy Hylton a8e71c13e9 Update dependencies. 2003-05-28 12:10:14 +00:00
Jeremy Hylton 2fb6124afd Appendix was removed. 2003-05-28 12:04:38 +00:00
Jeremy Hylton c428112d29 Rename lib__future__.tex to libfuture.tex and add link in lib.tex. 2003-05-28 11:57:52 +00:00
Jeremy Hylton cf9c46719c *** empty log message *** 2003-05-28 11:51:11 +00:00
Gregory P. Smith 5772513f0f Include a link to the pybsddb web documentation for the modern object
oriented DbEnv & Db object BerkeleyDB interface.

Include a note about Sleepycat's BerkeleyDB license with regards to
distributing it within non-opensource applications and include a link
to their website for license details.

Document that 'r' is the default flag for the legacy bsddb btopen(),
hashopen(), and rnopen() functions.  This is apparently different than the
dbm libraries in other languages according to Bug #732951.  Changing
the default from 'r' to 'c' would break backwards compatibility with
legacy bsddb applications; documenting the default should suffice.
2003-05-28 07:56:45 +00:00
Greg Ward 451a766953 More wordsmithing and cleanup. 2003-05-26 01:51:33 +00:00
Raymond Hettinger 8fb665a51a Fix ref counts in initialization code. 2003-05-25 17:59:38 +00:00
Greg Ward c316d0d391 Lots of wordsmithing and typographical improvement. 2003-05-23 02:44:46 +00:00
Fred Drake 5af41c55e6 Correct dependency information -- the Python docs load the "About this
document" text from html/stdabout.dat, not html/about.dat.
2003-05-22 15:28:55 +00:00
Fred Drake 4864bfb88f Minor elaboration in the information about reporting errors. 2003-05-22 15:09:27 +00:00
Fred Drake 6ce0b60063 update version history 2003-05-22 14:58:02 +00:00
Jeremy Hylton e41195fab6 Add documentation for __future__ 2003-05-21 21:45:01 +00:00
Jeremy Hylton 8bea5dc879 Move future statement here from appendix a. 2003-05-21 21:43:00 +00:00
Andrew M. Kuchling 28137a09d6 Don't mention __slots__ as a technique for error avoidance 2003-05-20 18:12:21 +00:00
Fred Drake 15eac1f95c Fix markup nits. 2003-05-20 16:21:51 +00:00
Tim Peters dbaf04ead6 Straighten out the docs for os.system(); the Unix and Windows behaviors
really can't be smushed together.

Bugfix candidate.
2003-05-20 16:15:58 +00:00
Fred Drake 6bab183d4e Markup nits. 2003-05-20 15:28:58 +00:00
Fred Drake e5a55519a8 Remove unused line numbers from example code.
Line numbering of examples is not used elsewhere.
2003-05-20 15:21:08 +00:00
Raymond Hettinger f9c2eda3c1 Fix missing parethesis. 2003-05-20 05:31:16 +00:00
Brett Cannon 235d1efe12 Add docs for key_file and cert_file arguments for HTTPSConnection. Copied from socket.ssl docs. 2003-05-20 02:56:35 +00:00
Skip Montanaro 7789237331 * Correct Sniffer doc to correspond to the implementation.
* Add optional delimiters arg to Sniffer.sniff() which restricts the set of
  candidate field delimiters.
2003-05-19 15:33:36 +00:00
Walter Dörwald 9e46abed50 Fix array.array.insert(), so that it treats negative indices as
being relative to the end of the array, just like list.insert() does.
This closes SF bug #739313.
2003-05-18 03:15:10 +00:00
Raymond Hettinger 047c54bb24 Missing parenthesis. 2003-05-16 14:36:26 +00:00
Jim Fulton 1f325562f0 Added some missing PyObject* casts in the deallocators.
Added some defines for PyMODINIT_FUNC so that the examples work
with Python 2.2.

I think I'm done hacking this documentation. Yippie! :)
2003-05-16 13:53:43 +00:00
Jim Fulton a24d73ddb1 Added a missing PyObject* cast to the dealloc examples.
Added a note that the mechanism for defining new tyoes documented here
only works for Python 2.2 and higher.
2003-05-16 13:51:58 +00:00
Jim Fulton aea763bde7 Removed reference to the out-of-date (and not very useful)
Objects/xxobject.c example.

Updated the discussion of type checking to refer to
PyObject_TypeCheck.
2003-05-16 13:32:59 +00:00
Guido van Rossum 8f512a22cd Add docs for MessageBeep. 2003-05-16 01:42:22 +00:00
Andrew M. Kuchling 7696344182 [Bug #471893] Replace security material with a warning against unpickling
untrusted data.
2003-05-14 16:51:46 +00:00
Fred Drake 126d366ea6 document Stats.dump_stats(), new for Python 2.3 2003-05-14 14:29:27 +00:00
Fred Drake c868d16e11 When an external application we use exits normally, exit with the same
exit code they returned.  All other types of exit from child processes
are normalized to a return code of 1.
Closes SF bug #732143.
2003-05-14 04:16:14 +00:00
Guido van Rossum bf1bef820c Add optional 'onerror' argument to os.walk(), to control error
handling.
2003-05-13 18:01:19 +00:00
Andrew M. Kuchling e9a54a3eaf [Bug #713722] Delete dangling references to unwritten sections 2003-05-13 15:02:06 +00:00
Andrew M. Kuchling c85bf58276 [Bug #732124] Clarify .pos, .endpos by saying 'method' instead of 'function'
Also, put match() description before search(); search() refers to match()
2003-05-13 14:40:24 +00:00
Andrew M. Kuchling 8d17709c5c Remove more markup from headers 2003-05-13 14:26:54 +00:00
Andrew M. Kuchling 433307b75d [Bug #729297] Remove markup in section headers 2003-05-13 14:23:54 +00:00
Andrew M. Kuchling eabd9a1314 [Bug #729817] Document the rexec and Bastion modules as dead 2003-05-13 14:16:18 +00:00
Andrew M. Kuchling 032bd0a9a8 Fix typo 2003-05-13 14:13:58 +00:00
Brett Cannon 1213bdd16d Fix and add reference to urllib.urlencode for parse_qsl? functions. 2003-05-13 02:50:36 +00:00
Jim Fulton d2eadc6946 Updated simple example. This should have been checked in the other
day, but I missfired in CVS.
2003-05-12 17:42:56 +00:00
Fred Drake 7af9f4dac3 Add a specific mention of the term "operator overloading" and add an
index entry.  Suggested to python-docs.
2003-05-12 13:50:11 +00:00
Raymond Hettinger bf3a75283c Fix minor typos. 2003-05-12 03:23:51 +00:00
Fred Drake 8f53cdcfce - object is a class type, not a function
- when marking a function, the trailing () should be included
  consistently
2003-05-10 19:46:39 +00:00
Raymond Hettinger b4c1d9be8f Fix unbalanced parethesis. 2003-05-10 08:51:28 +00:00
Raymond Hettinger 0dfd7a9361 Missing parenthesis found by texcheck.py 2003-05-10 07:40:56 +00:00
Martin v. Löwis 5467d4c0e3 Patch #612627: Add encoding attribute to file objects, and determine
the terminal encoding on Windows and Unix.
2003-05-10 07:10:12 +00:00
Raymond Hettinger eca984fcce Fix missing parenthesis. 2003-05-10 04:21:08 +00:00
Raymond Hettinger 52136a8bea Fixed spacing and unbalanced brackets or parenthesis. 2003-05-10 03:35:37 +00:00
Fred Drake 9f545c489a Make this format again. 2003-05-09 19:10:12 +00:00
Skip Montanaro a30dffbb53 add a note about accessing user-defined functions with an import statement
in the setup parameter
2003-05-09 18:21:02 +00:00
Fred Drake 3ec4dfd812 Make this format again. 2003-05-09 18:18:46 +00:00
Fred Drake 8b6ed26dc7 - remove bogus \end{description}
- fix two typos
2003-05-09 15:04:56 +00:00
Jack Jansen 1662162c04 Documented the new autoGIL module. 2003-05-09 14:45:04 +00:00
Jim Fulton 3ff5bb20b7 Fixed small typo Pointed out by Michael Hudson. 2003-05-08 10:35:07 +00:00
Jim Fulton 83cedcf660 Fixed a typo in an example dealloc routine that calls it's "self"
argument "obj" rather than "self".
2003-05-08 10:32:10 +00:00
Greg Ward 86e1790cad Clarify the dedent() example a bit by indenting the input lines unevenly. 2003-05-08 02:12:35 +00:00
Greg Ward 8f6329c547 SF patch #598163 (Ville Vainio, vvainio@users.sourceforge.net):
document dedent() function.
2003-05-08 02:09:49 +00:00
Brett Cannon 066f3928b2 Library documentation for the 'test' package. Still needs to be checked by Fred. 2003-05-07 22:02:17 +00:00
Jim Fulton aed0a4a138 Rewrote the basic section of the chapter on defining new types.
Changed the example to show how to create types the new way:

- Use a class new method rather than a new function.

- Use self->ob_type->tp_free in deallocators

- Use attribute descriptors rather than set/getattr methods.

- Make the type usable as a base type.

I split the example into 3 parts:

1. The minimal new type

2. Adding attributes and methods.

3. Finer control over attributes.

It's much simpler to define builtin types. These updates hopefully
show this.

I also made minor wording changes in two other places.

I still need to update xxobject.c
2003-05-07 19:48:13 +00:00
Raymond Hettinger a02469f969 More message updates and minor fixes. 2003-05-07 17:49:36 +00:00
Raymond Hettinger a2f84ceda5 Update traceback message 2003-05-07 17:11:15 +00:00
Andrew M. Kuchling fcf6b3ecde Add list.insert() change for negative positions
Add ~ to MvL's last name
Fix use of all-caps for a name
Bump version number
2003-05-07 17:00:35 +00:00
Skip Montanaro 45a9c93236 add missing parens - verified w/ interpreter - sorry to dismiss your comment
Fred
2003-05-07 16:01:43 +00:00
Skip Montanaro b4f12424a5 replace most uses of `...` by repr(...), noting that `...` is discouraged,
but convenient in interactive sessions.
2003-05-07 15:29:12 +00:00
Skip Montanaro 6d9f45bc3f add a note about the undocumented bsddb185 module 2003-05-06 20:40:17 +00:00
Jeremy Hylton 6cb52ddc3c Refer reader to platform library docs for specific semantics.
Resolves SF bugs 697989, 697988, 697986.
2003-05-05 16:46:26 +00:00
Greg Ward d72312857e Scattered wording and typographical improvements (up to but not
including the "Callback Options" section).
2003-05-03 21:22:58 +00:00
Greg Ward 649625bc05 Rename "The Tao of Option Parsing" section to "Philosophy".
Remove first-person usage from it.  Various wording tweaks.
2003-05-03 20:41:37 +00:00
Greg Ward 1f53517a8c Use True/False instead of 1/0 when talking about store_true/store_false.
Particularly important since they now store True and False rather than 1
and 0!
2003-05-03 20:13:08 +00:00
Greg Ward c50b088cfd Add a big comment about cross-platform issues (especially OpenBSD).
This should be turned into a footnote by someone who actually
understands OSS and its relationship to Linux, FreeBSD, OpenBSD, NetBSD,
etc.
2003-05-03 19:45:47 +00:00
Greg Ward bf8f1b55a8 Use TeX quotes -- ``foo'' -- as appropriate.
Remove whitespace around em-dashes.
2003-05-03 19:41:45 +00:00
Greg Ward b4e3319302 Fix various markup errors: use \longprogramopt{} more, and use it
correctly.  (Closes SF #731689.)  Use \emph{} in a few places.
2003-05-03 19:16:36 +00:00
Martin v. Löwis ec31047c0c Use \versionchanged, not \versionadded. 2003-05-03 10:59:13 +00:00
Martin v. Löwis 7829e5661c Patch #731514: Update recursion documentation to mention simple recursion. 2003-05-03 10:57:53 +00:00
Martin v. Löwis e59e2bab8f Patch #711902: Cause pydoc to show data descriptor __doc__ strings. 2003-05-03 09:09:02 +00:00
Fred Drake 8b34e7cc40 - add title attributes to the navigation icons on the navigation bars;
this causes some browsers to offer descriptive tooltips when the
  mouse hovers over the linked icon
- clean up the code in this area
2003-05-03 02:07:22 +00:00
Fred Drake 05404c3d7c add link types for the remaining links in the navigation panels 2003-05-02 20:30:18 +00:00
Fred Drake bf8ec3e035 - add link relationships to some of the links in the navigation panels
- implement custom_REL_hook() so LaTeX2HTML uses currently recommended
  link types; those work fine with tools like the Mozilla Site
  Navigation Bar
2003-05-02 20:18:01 +00:00
Raymond Hettinger 341deb74e7 The previous made the stop argument optional.
It is better to be explicit and just allow stop to be None.
2003-05-02 19:44:20 +00:00
Raymond Hettinger 14ef54cd83 SF bug #730685: itertools.islice stop argument is not optional
* itertools.islice() stop argument did not perform as documented.
* beefed-up test suite
2003-05-02 19:04:37 +00:00
Fred Drake 98b2576424 Avoid extraneous blank line generated in the middle of the document
head.
2003-05-02 18:21:22 +00:00
Fred Drake f06b90534b Remove section number from the title for use in the
<meta name='description' ...> element in the document head.
2003-05-02 18:08:16 +00:00
Fred Drake 90fc0b356f At the site of an indexed reference to print, point to the relevant
documentation.  Closes SF bug #723136.
2003-04-30 16:44:36 +00:00
Fred Drake b876bcc561 work around mostly-minor formatting problems; the encodings.idna
example still doesn't come out quite right: a bug in the formatting
tools
2003-04-30 15:03:46 +00:00
Fred Drake d4be747e1e - comment out \moduleauthor that broke formatting until the formatting
tools can be fixed; added XXX comment
- general markup fixes
2003-04-30 15:02:07 +00:00
Fred Drake c95628e3f2 - clean up some extra punctuation hidden in indexing markup
- fix a typo and one markup nit
- normalize whitespace
2003-04-29 13:56:40 +00:00
Fred Drake 83c19ee06b Clarify that the timeout argument to read_until() is in seconds. 2003-04-29 13:39:05 +00:00
Raymond Hettinger 6e887bb05f SF bug #729096: getopt online documentation example improvement
A newbie found it difficult to translate the exampe into a
case that used only short options or long options but not both.
He tried to shorten the tuple search but forgot the trailing comma,
The appropriate pattern is an equality check.

Revised the example to point him in the right direction.

Backport candidate.
2003-04-29 04:35:36 +00:00
Brett Cannon a2f8737faf Add comment that urlopen opens local files without universal newlines 2003-04-29 04:11:12 +00:00
Tim Peters a1af767c4d Reworded fabs() for consistency with the others. Noted that all
return values are floats.
2003-04-28 21:32:03 +00:00
Tim Peters a390c6e194 walk() docs: Emphasize that the recursive-delete example is dangerous. 2003-04-28 19:15:10 +00:00
Tim Peters 5501b5e3d7 SF bug 728097: tmpnam problems on windows 2.3b, breaks test.test_os.
tmpnam() appears essentially useless on Windows, and it finally broke
the test for Irmen de Jong.  Read the long new comment in test_tmpnam()
for details.  Since the MS implementation is insane, it might be good
if we supplied a different implementation.

Bugfix candidate.
2003-04-28 03:13:03 +00:00
Tim Peters bf89b3a1f7 walk() docs: Worked "walking" into the description and the text. Added
a brief example where bottom-up walking is essential.
2003-04-28 02:09:43 +00:00
Tim Peters 965697fc4b Clarified new text about math exceptions.
Bugfix candidate.
2003-04-26 15:11:08 +00:00
Skip Montanaro 5118341530 Add note about platform-specific behavior arising from discussion on bug
711019.
2003-04-26 02:59:00 +00:00
Fred Drake 2f36b3e205 Version updates for Python 2.3. 2003-04-26 00:52:30 +00:00
Fred Drake 9635268ea9 organizational and markup cleansing 2003-04-25 18:02:34 +00:00
Fred Drake c440af5495 Updated information on package metadata to reflect recent additions.
This is a modified form of SF patch #718027 (mostly markup changes).
2003-04-25 16:43:28 +00:00
Fred Drake d198f38505 - add availability statements for some of the new APIs
- lots of general cleanup
2003-04-25 16:16:02 +00:00
Fred Drake 53e5b71bbc Add modified versions of the examples from Sean Reifschneider
(SF patch #545480).
2003-04-25 15:27:33 +00:00
Guido van Rossum b016752d8b Fix a copy-paste error: the paragraph about inet_ntop's use was copied
literally from inet_pton.
2003-04-25 15:26:58 +00:00
Skip Montanaro 5d0136e297 reflect csv's change back to a module. Document the new sniffer api. 2003-04-25 15:14:49 +00:00
Fred Drake 9f48045ec0 Use a simpler \note instead of a "See also" section to refer to the
os.walk() generator.
2003-04-25 15:12:47 +00:00
Neal Norwitz 6eb502f267 Add versionadded for has_ipv6 attribute 2003-04-25 14:53:48 +00:00
Neal Norwitz cabf56f8b4 Fix markup 2003-04-25 14:52:41 +00:00
Fred Drake 2194a4eede markup adjustments 2003-04-25 14:50:06 +00:00
Tim Peters c4e0940042 New generator os.walk() does a bit more than os.path.walk() does, and
seems much easier to use.  Code, docs, NEWS, and additions to test_os.py
(testing this sucker is a bitch!).
2003-04-25 07:11:48 +00:00
Guido van Rossum 47dfa4a89a Patch by Jp Calderone:
- The socket module now provides the functions inet_pton and inet_ntop
  for converting between string and packed representation of IP addresses.
  See SF patch #658327.

This still needs a bit of work in the doc area, because it is not
available on all platforms (especially not on Windows).
2003-04-25 05:48:32 +00:00
Andrew M. Kuchling f8d0c075b2 [Patch #628208] Document the allow_none argument 2003-04-25 00:29:31 +00:00
Skip Montanaro 3bd3c8403a * minor tweaks relating to the package nature of the beast
* added an (incomplete) description of the utils.Sniffer class
2003-04-24 18:47:31 +00:00
Barry Warsaw 50889239c3 Updated a bunch of docs to describe how message ids and strings are
Unicode in GNUTranslations.  Also provide better descriptions of
*gettext() overridden methods, esp. w.r.t. the behavior in the face of
fallbacks.
2003-04-24 18:14:49 +00:00
Andrew M. Kuchling 035272be91 Add some more items 2003-04-24 16:38:20 +00:00
Fred Drake c11076e0da Bump the release information. 2003-04-24 16:37:21 +00:00
Fred Drake d859d470a1 Add cross-references between urllib.urlencode() and cgi.parse_qs[l]().
Closes SF bug #724751.
2003-04-24 16:22:47 +00:00
Raymond Hettinger 024aaa1bfe SF Patch 549151: urllib2 POSTs on redirect
(contributed by John J Lee)
2003-04-24 15:32:12 +00:00
Fred Drake 1d5854fdc4 Note the platform module. 2003-04-24 15:24:46 +00:00
Andrew M. Kuchling 13b4c41748 Mention deprecation of rotor module 2003-04-24 13:23:43 +00:00
Andrew M. Kuchling bbb9a55327 [Patch #679505] Document that this module is deprecated 2003-04-24 13:19:09 +00:00
Brett Cannon 317ad7a5ee Fixed docs for urlretrieve() to match code in the case of opening a local file.
Also some typos and removed trailing whitespace on the lines.
2003-04-24 02:31:14 +00:00
Fred Drake c22b2999f6 fix some markup errors 2003-04-23 20:38:41 +00:00
Skip Montanaro 54a234a566 clarify - restrict version mention to the trunk version 2003-04-23 20:35:14 +00:00
Skip Montanaro 1bd1d858ae added note about character set limitations in passwords. 2003-04-23 20:22:12 +00:00
Thomas Heller 34d7f0927b Document the new functions PyInt_AsUnsignedLongMask(), PyInt_AsUnsignedLongLongMask(),
PyLong_AsUnsignedLongMask(), PyLong_AsUnsignedLongLongMask().
2003-04-23 19:51:05 +00:00
Tim Peters 2d1c846b73 Clarified new fsync() docs. 2003-04-23 19:47:14 +00:00
Thomas Heller 42a1172cf4 Document the new format codes B, H, I, k, K. 2003-04-23 19:27:35 +00:00
Fred Drake 444e434011 Update the package list whenever we build distfiles.
This is used on www.python.org.
2003-04-23 15:04:52 +00:00
Tim Peters 11b2306960 Enable os.fsync() for Windows, mapping it to MS's _commit() there. The
docs here are best-guess:  the MS docs I could find weren't clear, and
some even claimed _commit() has no effect on Win32 systems (which is
easily shown to be false just by trying it).
2003-04-23 02:39:17 +00:00
Raymond Hettinger 863983e8e5 Add comment on performance.
Fix missing right parenthesis.
Add three examples.
2003-04-23 00:09:42 +00:00
Fred Drake 70995830a6 markup corrections 2003-04-22 18:54:53 +00:00
Fred Drake 282be3ab89 - explain the start argument to sum()
- various adjustments to sum() markup and explanation
2003-04-22 14:52:08 +00:00
Fred Drake 03e929e7e0 Fix some markup nits. 2003-04-22 14:30:53 +00:00
Alex Martelli a70b19147f Adding new built-in function sum, with docs and tests. 2003-04-22 08:12:33 +00:00
Gustavo Niemeyer 48f3dcc93e - Changed shlex.split() method to have more useful and
meaningful parameters.
2003-04-20 01:57:03 +00:00
Gustavo Niemeyer cf146d31e7 - Included examples documenting how the lastindex member of
match objects work.
2003-04-20 01:48:59 +00:00
Martin v. Löwis 153c9e493e Patch #553171: Add writeback parameter. Also add protocol parameter. 2003-04-19 20:59:03 +00:00
Guido van Rossum a26854095b - Several methods of nntplib.NNTP have grown an optional file argument
which specifies a file where to divert the command's output
  (already supported by the body() method).  (SF patch #720468)
  Thanks to Terry Carroll.
2003-04-19 18:04:57 +00:00
Andrew M. Kuchling e36b690087 Mention the bz2 module
Various rewrites
2003-04-19 15:38:47 +00:00
Barry Warsaw b05df5796a Added some more documentation to as_string() to make it clear that
it's a convenience only.  Give an example of what to do for more
flexibility.
2003-04-18 23:03:53 +00:00
Martin v. Löwis 338bcbccfa Change email address. 2003-04-18 22:04:34 +00:00
Martin v. Löwis faf71ea5b3 Fix spelling of cedillas. 2003-04-18 21:48:56 +00:00
Martin v. Löwis 07d4fb6f17 Correct methoddesc environments. 2003-04-18 21:48:13 +00:00
Martin v. Löwis 382f078437 Add lib/libstringprep.tex lib/libdocxmlrpc.tex. 2003-04-18 21:45:26 +00:00
Martin v. Löwis 281b2c6211 Patch #536883: SimpleXMLRPCServer auto-docing subclass. 2003-04-18 21:04:39 +00:00
Fred Drake cf6d74aedd - accepted (slightly) modified version of docs for the OptionGroup
class; closes SF patch #697941
- use em-dashes intead of en-dashes
- section references: use a "tie" between the word "section" and the
  section number, use quotation marks around section titles
- other minor markup corrections/cleanups
2003-04-18 15:50:13 +00:00
Martin v. Löwis 2548c730c1 Implement IDNA (Internationalized Domain Names in Applications). 2003-04-18 10:39:54 +00:00
Neal Norwitz 10cf21802d Use True in a few more places.
Use isinstance(somestring, basestring) instead of type() as per PEP 8
2003-04-17 23:09:08 +00:00
Neal Norwitz a6bdf2aef6 Oops, missed updating doc to correct version for split 2003-04-17 23:07:13 +00:00
Fred Drake 30b6e8230b Added documentation for the handle_pi() method, based on SF patch #662464.
Closes SF bug #659188, patch #662464.
2003-04-17 22:36:52 +00:00
Fred Drake aa3b5d2ec5 markup banalities 2003-04-17 21:49:04 +00:00
Gustavo Niemeyer 68d8cef89a Implemented posix-mode parsing support in shlex.py, as dicussed in
mailing list, and in patch #722686.
2003-04-17 21:31:33 +00:00
Raymond Hettinger 2ed6dff796 As discussed on python-dev, revised docs to note that
PyObject_IsTrue() can have an error result.

Also, added missing docs for PyObject_Not().

Will backport.
2003-04-16 17:28:12 +00:00
Neal Norwitz 1475c49211 Add version info for name2codepoint and codepoint2name 2003-04-16 13:21:06 +00:00
Walter Dörwald 5688b7ac3e Add two dictionaries to htmlentitydefs: name2codepoint maps
HTML entity names to Unicode codepoints (as integers).
codepoint2name is the reverse mapping. From SF patch #722017.
2003-04-16 09:46:13 +00:00
Guido van Rossum 0fc8f00252 - pythunrun.c, Py_Finalize(): move the call to _Py_PrintReferences()
even farther down, to just before the call to
  _PyObject_DebugMallocStats().  This required the following changes:

- pystate.c, PyThreadState_GetDict(): changed not to raise an
  exception or issue a fatal error when no current thread state is
  available, but simply return NULL without raising an exception
  (ever).

- object.c, Py_ReprEnter(): when PyThreadState_GetDict() returns NULL,
  don't raise an exception but return 0.  This means that when
  printing a container that's recursive, printing will go on and on
  and on.  But that shouldn't happen in the case we care about (see
  first bullet).

- Updated Misc/NEWS and Doc/api/init.tex to reflect changes to
  PyThreadState_GetDict() definition.
2003-04-15 15:12:39 +00:00
Guido van Rossum 3a3cca5b82 - list.insert(i, x) now interprets negative i as it would be
interpreted by slicing, so negative values count from the end of the
  list.  This was the only place where such an interpretation was not
  placed on a list index.
2003-04-14 20:58:14 +00:00
Andrew M. Kuchling b43f15e1ce Add a name 2003-04-14 18:47:28 +00:00
Andrew M. Kuchling 44c62ef5ee Typo fix 2003-04-14 15:32:18 +00:00
Andrew M. Kuchling d39078ba2d Mention timeit module
Fix error in description of logging package's 'propagate'
Mention default arg to dict.pop()
Link to more module docs
   (I wonder if I should adopt some convention such as linking the first
    mention of all new modules to the LibRef?)
Various text changes
Bump version number and Python version
2003-04-13 21:44:28 +00:00
Andrew M. Kuchling ba887bb04e Use simpler import 2003-04-13 21:13:02 +00:00
Barry Warsaw 125b9b0736 Back out of setting the default charset to iso-8859-1. 2003-04-11 21:28:10 +00:00
Neal Norwitz 06c7b62a83 Fix markup 2003-04-11 18:48:03 +00:00
Barry Warsaw a1ce93f87c From http://mail.python.org/pipermail/i18n-sig/2003-April/001557.html
- Expose NullTranslations and GNUTranslations to __all__

- Set the default charset to iso-8859-1.  It used to be None, which
would cause problems with .ugettext() if the file had no charset
parameter.  Arguably, the po/mo file would be broken, but I still think
iso-8859-1 is a reasonable default.

- Add a "coerce" default argument to GNUTranslations's constructor.  The
reason for this is that in Zope, we want all msgids and msgstrs to be
Unicode.  For the latter, we could use .ugettext() but there isn't
currently a mechanism for Unicode-ifying msgids.

The plan then is that the charset parameter specifies the encoding for
both the msgids and msgstrs, and both are decoded to Unicode when read.
For example, we might encode po files with utf-8. I think the GNU
gettext tools don't care.

Since this could potentially break code [*] that wants to use the
encoded interface .gettext(), the constructor flag is added, defaulting
to False.  Most code I suspect will want to set this to True and use
.ugettext().

- A few other minor changes from the Zope project, including asserting
that a zero-length msgid must have a Project-ID-Version header for it to
be counted as the metadata record.
2003-04-11 18:36:43 +00:00
Jack Jansen bae5c965e8 Moved all the scripting stuff to a separate section, added all the
missing bits (well, all the bits I could think of) and updated the
rest.
2003-04-11 15:35:28 +00:00
Neal Norwitz ffe33b7f24 Attempt to make all the various string *strip methods the same.
* Doc - add doc for when functions were added
 * UserString
 * string object methods
 * string module functions
'chars' is used for the last parameter everywhere.

These changes will be backported, since part of the changes
have already been made, but they were inconsistent.
2003-04-10 22:35:32 +00:00
Neal Norwitz 4efd91713b Add a space after expression to be consistent 2003-04-10 21:51:29 +00:00
Fred Drake 12dd7b12c6 Minor markup adjustments. 2003-04-09 18:15:57 +00:00
Guido van Rossum 6db771871e Try to discourage use of PyObject_Type(). 2003-04-09 18:02:23 +00:00
Andrew M. Kuchling a6b1c75b7a Re-indent example; fix typo 2003-04-09 17:26:38 +00:00
Jack Jansen d5e0a5a08e Created a minimal MacOSX section. 2003-04-09 15:12:38 +00:00
Fred Drake fcd845a7ed Lots of small markup adjustments. 2003-04-09 04:06:37 +00:00
Fred Drake 61a0a73d76 Add dependency information for the hotshot package docs. 2003-04-09 03:25:07 +00:00
Anthony Baxter fda5e27ec9 extra punctuation removed 2003-04-09 03:03:46 +00:00
Fred Drake 567b0a6445 Add dependency information for the timeit module docs. 2003-04-09 02:41:36 +00:00
Skip Montanaro d6e9fe386a + libtimeit 2003-04-09 01:39:06 +00:00
Skip Montanaro ca652746ff doc for timeit module/script - mostly just a recast of Tim's docstring 2003-04-09 01:38:53 +00:00
Fred Drake 2c2068c4d1 Added example of using positional and keyword args with atexit.register().
Based on a suggestion from a reader.
2003-04-08 17:46:53 +00:00
Fred Drake de7ad2caac Markup fix. 2003-04-08 17:37:47 +00:00
Tim Peters 730f5535ba s/referrents/referents/g. Gotta love that referrers remains rife with rs. 2003-04-08 17:17:17 +00:00
Tim Peters 0f81ab6d88 Finished implementing gc.get_referrents(): dealt with error and end
cases, wrote docs, added a test.
2003-04-08 16:39:48 +00:00
Anthony Baxter cb8ed53014 add note suggested by rhettinger about example. 2003-04-07 12:21:56 +00:00
Anthony Baxter b3303efec6 patch [ 698505 ] docs for hotshot module 2003-04-07 12:19:15 +00:00
Fred Drake 2a04623ddd - add the "download_url" field to the pre-2.2.3 metadata compatibility note
- fix some markup nits
2003-03-31 16:23:09 +00:00
Fred Drake 007fadd59d Fix symbol in grammar; this should fix some hyperlinking in the HTML
version.
2003-03-31 14:53:03 +00:00
Martin v. Löwis 24b8881f61 Patch #701395: Correct documentation of PyUnicode_Splitlines. 2003-03-30 16:40:42 +00:00
Martin v. Löwis b9a0f91218 Rename LONG_LONG to PY_LONG_LONG. Fixes #710285. 2003-03-29 10:06:18 +00:00
Ka-Ping Yee bd379e9627 PyWeakref_GetObject returns None (not NULL) when the referent is gone. 2003-03-28 18:07:16 +00:00
Martin v. Löwis 3ae0f7a7cf Replace criterium with criterion. Fixes #705120. 2003-03-27 16:59:38 +00:00
Neal Norwitz 24fcd23eae Back out previous change as discussed on python-checkins 2003-03-22 16:19:52 +00:00
Neal Norwitz 1e942bd3f4 Add lib/mimelib.tex to dependencies 2003-03-22 00:23:04 +00:00
Barry Warsaw bfa893f3ac email is at version 2.5 now 2003-03-21 21:14:48 +00:00
Andrew M. Kuchling a092ba1adc Add PEP 307 section 2003-03-21 18:32:43 +00:00
Andrew M. Kuchling a978e10676 Add PEP305 section 2003-03-21 18:10:12 +00:00
Andrew M. Kuchling c71bb97e2f Update datetime section a bit 2003-03-21 17:23:07 +00:00
Neal Norwitz 0135b65c01 Add new CSV module to doc dependancies 2003-03-21 00:28:30 +00:00
Skip Montanaro 5fbf8362a3 include csv doc section - Fred, you may want to change the location 2003-03-20 23:35:00 +00:00
Skip Montanaro b4a0417e91 new CSV file processing module - see PEP 305 2003-03-20 23:29:12 +00:00
Fred Drake 4cee220ff3 - added example of using a comparison function with list.sort(), and
explained the construction of a [(key, value), ...] list as an
  alternative
- note that support for cmpfunc=None was added in 2.3
2003-03-20 22:17:59 +00:00
Fred Drake 62364ffb80 - apply SF patch #700798: fixes and cleanups for descriptor info
- use a TeX "tie" to prevent word-wrapping in "section x.y"-like text
2003-03-20 18:17:16 +00:00
Skip Montanaro 2a403e8a7e add descriptions of {get,set}defaulttimeout. 2003-03-20 17:58:12 +00:00
Fred Drake 5c7b2487cd - explain what a UNC path is in the makedirs() description, since
they're actually mentioned there
- remove some extraneous paragraph separations
- \versionadded --> \versionchanged in one place
2003-03-20 17:39:38 +00:00
Michael W. Hudson 43ed43bfc1 Take out my (long since disabled) POSIX signal mask handling code.
I'm not going to have the time or energy to get this working x-platform
-- anyone who does is welcome to the code!
2003-03-13 13:56:53 +00:00
Raymond Hettinger 60de2e837f SF bug #699237: Tutorial uses omitted slice indices before explaining them
Moved up the explanation of slice default arguments.
2003-03-12 04:46:52 +00:00
Barry Warsaw 45c3941510 Update the package version number 2003-03-12 03:43:09 +00:00
Barry Warsaw a996d4f137 For email 2.5b1, we no longer add a trailing newline to
MIMEText.__init__()'s _text argument if it doesn't already end in a
newline.  This may be controversial.
2003-03-11 05:03:25 +00:00
Barry Warsaw 52b39f5b47 body_line_iterator() now takes a decode argument. 2003-03-11 04:40:14 +00:00
Barry Warsaw 20ebc37013 Describe what happens when decode=True and the payload has bogus
base64 data.
2003-03-10 16:13:50 +00:00
Greg Ward cd930f5258 openmixer()'s 'mode' parameter has been removed. 2003-03-10 03:18:19 +00:00
Greg Ward f882c77d70 Expand description of ossaudiodev.error exception.
Improve descriptions of open(), openmixer().
2003-03-10 03:05:21 +00:00
Greg Ward 3e34f59ce2 Rewrite intro paragraphs and add a "See also" box for the link to the
official OSS docs.

Markup fixes: change \code{} variously to \function{}, \method{}, or
\constant{} as appropriate.
2003-03-10 02:09:51 +00:00
Greg Ward 074472ba98 Fix two unformatted lists: one is now an 'enumerate' environment, the
other a 'tableii'.

Formatting/typo fix.
2003-03-10 00:24:42 +00:00
Greg Ward 41a28e374c Add libossaudiodev.tex. 2003-03-10 00:07:14 +00:00
Greg Ward 33bcd987dd Wrap all paragraphs to 72 columns.
Two spaces between sentences.
Fix em-dashes -- should be "---" not " - ".
Spelling fix.
2003-03-09 23:57:34 +00:00
Greg Ward 620e343c0a Documentation for the ossaudiodev module.
Initial revision supplied by Nicholas FitzRoy-Dale <wzdd@lardcave.net>
(emailed to me [gward@python.net] 2003-03-08 23:37 +1100).
2003-03-09 23:34:52 +00:00
Raymond Hettinger 5284b4474e Add contributor name. 2003-03-09 07:19:38 +00:00
Raymond Hettinger 42182ebaf6 SF 698520: Iterator for urllib.URLOpener
Contributed by Brett Cannon.
2003-03-09 05:33:33 +00:00
Skip Montanaro 959c7727f4 Add a little more verbiage about the bsddb module/package change. It's
clear from recent discussions on c.l.py that people are a bit confused about
the differences between the old bsddb, the new bssdb, the bsddb3/PyBSDDB
package and changes to file formats.  Tried to clarify the issues.
2003-03-07 15:45:15 +00:00
Fred Drake 9e1595e6e4 Minor clarification about the ob_size field. 2003-03-07 15:02:03 +00:00
Raymond Hettinger a3e1e4cd79 SF patch #693753: fix for bug 639806: default for dict.pop
(contributed by Michael Stone.)
2003-03-06 23:54:28 +00:00
Neal Norwitz 1930949a8a Fix SF bug #697256, PyMarshal_WriteShortToFile() documented, but not implemented
Remove prototype and doc.  Backport candidate.
2003-03-06 22:04:24 +00:00