Commit Graph

6348 Commits

Author SHA1 Message Date
Fred Drake 11b138fbf7 remove useless <br/> from the top navigation panel 2003-09-11 04:14:20 +00:00
Fred Drake 4587fa21ea try to fix up the padding inside a notice environment so they fit in a
little better, with similar spacing characteristics with the seealso
environment
2003-09-11 04:08:47 +00:00
Fred Drake 7c4d8f3ca9 - add version annotation for HIGHEST_PROTOCOL
- cleaned up some markup
2003-09-10 20:47:43 +00:00
Brett Cannon 62dba4c277 select.select() now accepts a sequence (as defined by PySequence_Fast()) for
its first three arguments.

Closes RFE #798046 .
2003-09-10 19:37:42 +00:00
Skip Montanaro fd4fa8801a mention new module doc display feature of pydoc in libref and NEWS 2003-09-10 19:04:13 +00:00
Raymond Hettinger 6e380cd1d8 SF bug #803679: Missing section number in csv module documentation 2003-09-10 18:54:49 +00:00
Raymond Hettinger 5bcc933211 SF bug #803842: Wrong description of regexp concatenation 2003-09-10 18:45:12 +00:00
Raymond Hettinger 0d6e8cde1a SF bug #802302: Invalid documentation for dbhash.
The documentation severely departed for the actual implementation.
2003-09-10 04:44:29 +00:00
Raymond Hettinger bed92ee2b2 SF patch #800899: Making "|" directive from REs a bit clearer. 2003-09-10 03:54:50 +00:00
Raymond Hettinger 9756f388c0 Fix typo. 2003-09-10 00:11:28 +00:00
Fred Drake f5f0c17b85 end-of-sentence punctuation comes *before* \footnote, not after 2003-09-09 19:49:18 +00:00
Raymond Hettinger dfa7bd97ff SF #801306: Bad RE in scanf example 2003-09-09 01:30:13 +00:00
Raymond Hettinger 74923d73ee SF bug #560286: Add docs for 'basestring' 2003-09-09 01:12:18 +00:00
Raymond Hettinger a098b33c93 Add an example to address a common question of how to split iterators. 2003-09-08 23:58:40 +00:00
Raymond Hettinger f350160d43 Fix spacing markup and other sundries. 2003-09-08 19:01:04 +00:00
Raymond Hettinger b67449d31d Fix spacing markup and other sundries. 2003-09-08 18:52:18 +00:00
Fred Drake a26c16c821 fix \NULL with following space and no {} (two instances) 2003-09-07 02:33:37 +00:00
Fred Drake 4ccf6e738e fix \NULL with following space and no {} 2003-09-07 02:32:55 +00:00
Brett Cannon 77e0212b8a Fix minor LaTeX bug of not ending a \NULL{} with the curly braces to get the
spacing correct in the output.
2003-09-07 02:22:16 +00:00
Fred Drake 60e868abd2 - reorganize sections
- correct section level error (module references are always \section)
- many markup revisions, including some minor rewordings
2003-09-06 17:51:16 +00:00
Fred Drake 5b52717130 add missing dependency 2003-09-06 06:42:01 +00:00
Raymond Hettinger 99812134be SF bug 799191: fix markup 2003-09-06 05:47:31 +00:00
Raymond Hettinger 1c90a6754c SF bug 799367: grammar error 2003-09-06 05:36:13 +00:00
Raymond Hettinger 951976dc9f SF bug #801486: Markup error. 2003-09-06 04:39:54 +00:00
Fred Drake c8b08b446a add a note about how \ulink should be different than it actually is
for PDF generation
2003-09-06 04:19:43 +00:00
Fred Drake 38f6b8845b Elaborate the explanation of different flavors of _* identifiers.
Fixes SF bug #520325.
2003-09-06 03:50:07 +00:00
Fred Drake c0678ffc60 - create a hyperlink for a section reference (also more robust in the
face of section re-ordering)
- fix minor markup nits for better presentation
2003-09-06 03:33:32 +00:00
Fred Drake f3552130e2 avoid spurious vertical whitespace preceeding heading which are marked
with a \label
2003-09-06 01:10:14 +00:00
Fred Drake 74530ff4f9 markup updates 2003-09-05 15:50:20 +00:00
Fred Drake 1b1ca0cc2b normalize whitespace; detabify 2003-09-05 15:43:58 +00:00
Fred Drake 41aa018398 fix some nuissance formatting problems for the "alltt" environment;
there's still a bug for the environment, but that's worked around in
this change as well
2003-09-05 15:43:00 +00:00
Fred Drake d37154f7f2 normalize whitespace 2003-09-05 15:36:23 +00:00
Fred Drake a1a1dba2d4 add index entry 2003-09-05 14:06:35 +00:00
Fred Drake 6a002cafa2 fix minor markup nits 2003-09-05 14:01:15 +00:00
Fred Drake 911e571a1c add a relevant "see also" link 2003-09-05 13:59:10 +00:00
Fred Drake 929d95957b make the padding inside a "See also" box more consistent around the
sides
2003-09-05 13:58:26 +00:00
Fred Drake b24e84c558 clean up some markup 2003-09-05 13:48:02 +00:00
Fred Drake 7a55642ff6 normalize whitespace 2003-09-04 22:21:17 +00:00
Fred Drake 0739c44bbd Suppress more online-only navigation in the printed HTML. 2003-09-04 22:16:45 +00:00
Fred Drake ecbfceb31c make sure cells are really generated for all table cells, even those
that are left empty
fixes first of the problems reported in SF bug #727692
2003-09-04 21:25:03 +00:00
Fred Drake b79f343e61 adjust markup to avoid suppressing a word space in content 2003-09-04 19:52:02 +00:00
Fred Drake 859c46a1fd Make the redundent portion of the lower navigation area disappear from the
printed version for browsers that support "@media print" in CSS.
2003-09-04 19:30:15 +00:00
Martin v. Löwis ef36537b81 Patch #792338: Correct documentation for timetuple return type. 2003-09-04 18:29:53 +00:00
Martin v. Löwis 25f90d5c5d Use de_DE in example, change message for unknown locale. Fixes #797447.
Will backport to 2.3.
2003-09-03 04:50:13 +00:00
Raymond Hettinger 09c7b6075c SF patch #798255: Document httplib.HTTPResponse.read "amt" argument
(Contributed by Jeff Epler.)
2003-09-02 02:32:54 +00:00
Raymond Hettinger aa1178b811 Minor typo 2003-09-01 23:13:04 +00:00
Raymond Hettinger c75c3e0392 SF patch #791153: inconsistency with implementation(logging)
(Contributed by George Yoshida.)
2003-09-01 22:50:52 +00:00
Raymond Hettinger 6f6d7b93bc SF bug #797853: Small problems with the csv module's documentation 2003-08-31 05:44:54 +00:00
Raymond Hettinger 2f3e5483a3 SF bug #732120:An extended definition of "non-overlapping" would save time.
Clarified the meaning of non-overlapping in patterns with zero length
matches.
2003-08-31 05:29:02 +00:00
Raymond Hettinger 0a6aa28681 SF patch #797157: Bug 794658: os.chmod docs, stat constants
(Contributed by Christos Georgiou.)

Reference the symbol definitions in the stat module.
2003-08-31 05:09:52 +00:00
Raymond Hettinger 9d12ab5c3c Fix long option markup. 2003-08-31 04:20:12 +00:00
Raymond Hettinger 8170200ce2 SF patch #797180: Bug 792656: slicing explained 2003-08-30 23:31:31 +00:00
Raymond Hettinger 57d71289a1 SF patch #797868: Tutorial, sec. 5.1.4 could contain an extra example
(Revised from the original patch contributed by Michal Pasternak.)

Also, make a couple minor fixups elsewhere.
2003-08-30 23:21:32 +00:00
Andrew M. Kuchling 77ad829261 [Bug #780231] One of the changes described in the 2.3 "What's New" document
actually occurred in 2.2.  Move the description to whatsnew22.tex.

[Bugfix candidate -- I'll backport to 2.3 (another 2.2 bugfix seems unlikely)
2003-08-29 17:49:26 +00:00
Fred Drake 9e78d1e1e5 fix minor syntactic faux pas 2003-08-29 04:09:26 +00:00
Fred Drake 4f4dbef2ca remove extra word occurance; reported to webmaster 2003-08-27 15:11:40 +00:00
Raymond Hettinger 9e3864190c Make the derived tools amendable to cut and paste. 2003-08-25 05:06:09 +00:00
Raymond Hettinger 9bd308f67b Fix doubled word typos. 2003-08-25 04:43:53 +00:00
Raymond Hettinger e41d4c8ec9 Added doubled word warnings. 2003-08-25 04:39:55 +00:00
Raymond Hettinger 999b57c872 Fix double word typos. 2003-08-25 04:28:05 +00:00
Raymond Hettinger 9ac25ec025 SF bug #793702: Section 13.1 HTMLParser documentation error
The -- is special to TeX and was printing as just -.
2003-08-25 03:31:28 +00:00
Raymond Hettinger c2a5cb2327 Fix typo.
Thou shalt not count to two unless proceeding to the number three.
2003-08-23 03:49:08 +00:00
Raymond Hettinger f4bb1f946e Fix typo. 2003-08-23 03:38:11 +00:00
Greg Ward 4892381207 Fix a loooong-standing brainfart: I got the site-packages path for
Python 1.5.2 wrong in the section on config files.
2003-08-23 02:09:18 +00:00
Barry Warsaw 463c5a868f Update get_param() description to reflect changes to the docstring. 2003-08-19 04:26:59 +00:00
Raymond Hettinger 6a1801271a Improvements to set.py:
* Relaxed the argument restrictions for non-operator methods.  They now
  allow any iterable instead of requiring a set.  This makes the module
  a little easier to use and paves the way for an efficient C
  implementation which can take better advantage of iterable arguments
  while screening out immutables.

* Deprecated Set.update() because it now duplicates Set.union_update()

* Adapted the tests and docs to include the above changes.

* Added more test coverage including testing identities and checking
  to make sure non-restartable generators work as arguments.

Will backport to Py2.3.1 so that the interface remains consistent
across versions.  The deprecation of update() will be changed to
a FutureWarning.
2003-08-17 08:34:09 +00:00
Fred Drake 236ffba400 Adjust some horizontal indentation to be consistent with the style used
throughout the documentation.
2003-08-16 06:30:47 +00:00
Raymond Hettinger 7ceb29e4a5 Incorporate documentation suggestions from feedback on comp.lang.python.
* Positive wording for the description of why < and > and = can all
  be False.

* Move to a three column table format that puts long method names
  side-by-side with their operator equivalents

* Mention that KeyError can be raised by Set.pop() and Set.remove().

* Minor tweaks to the examples.

Will backport as soon as Fred rebuilds the docs so I can confirm
the tables formatted properly
2003-08-16 00:56:40 +00:00
Neil Schemenauer 90b182c16c Don't introduce map(None, ...) in the tutorial. In practice, zip() is
usually preferred.
2003-08-14 22:57:46 +00:00
Raymond Hettinger fb857893a2 SF patch #787929: reflect the introduce of boolean type(libcfgparser.tex)
(Contributed by George Yoshida.)
2003-08-14 19:58:35 +00:00
Fred Drake 8fd8def1fa fix markup 2003-08-14 04:51:24 +00:00
Andrew M. Kuchling 69f31eb80c [Patch #739124] Add use_default_colors() to curses module 2003-08-13 23:11:04 +00:00
Raymond Hettinger c7a26562f9 SF patch#786531 'the the' typo. Contributed by George Yoshida 2003-08-12 00:01:17 +00:00
Raymond Hettinger f17d65da3a SF patch#786531 'the the' typo. Contributed by George Yoshida 2003-08-12 00:01:16 +00:00
Skip Montanaro bc961e5714 add a statement identifying StringI and StringO objects. 2003-08-11 15:06:07 +00:00
Raymond Hettinger 12c484dab8 SF patch #783807: Clarify PySequence_Setitem ref counting
(Contributed by Jay T Miller.)
2003-08-09 04:37:14 +00:00
Raymond Hettinger 0eec08794c Explain argument unpacking 2003-08-08 23:32:46 +00:00
Raymond Hettinger 6e13bcc7b1 SF bug #775836: change 0,1 to False,True in dict.has_key doc 2003-08-08 11:07:59 +00:00
Raymond Hettinger b5a420883c Modified itertools.izip() to match the behavior of __builtin__.zip()
which can now take zero arguments.
2003-08-08 05:10:41 +00:00
Raymond Hettinger c7d7766fda Improve docs:
* Simplify the pure python examples
* Add a quantify() example
2003-08-08 02:40:28 +00:00
Fred Drake bb18f620ad Fix hyperlinks and one class reference.
Backporting to Python 2.3 branch.
2003-08-07 14:31:08 +00:00
Raymond Hettinger f8a52d38ad Removed deprecated functions 2003-08-05 12:23:19 +00:00
Raymond Hettinger 02771c174c SF patch #782810: typo in libfuture.tex
(Contributed by George Yoshida)
2003-08-05 11:40:21 +00:00
Martin v. Löwis cebcc61d4d Patch #781126: Fix markup for add_fallback. Will backport to 2.3. 2003-08-05 05:54:15 +00:00
Fred Drake 5d9c636faf init_myformat(): None of the "mark" values can be empty strings, or
LaTeX2HTML feels free to remove a surrounding element that
    contains no other content.  Since such an element is typically a
    named anchor used for hyperlinking, they should not be removed.
    Unfortunatley, making sure these marks are non-empty is the most
    direct way of avoiding this behavior.

Thanks to Dave Kuhlman for tracking this down; this was some excellent
detective work!
2003-08-05 05:00:23 +00:00
Brett Cannon b278ac4e46 Add note about fileno not being usable as a normal file descriptor in Windows. 2003-08-05 03:51:24 +00:00
Fred Drake e0c1740bc5 better support for well-formed XHTML 2003-08-05 03:48:29 +00:00
Fred Drake 2fc88a62d4 make the portions of the generated HTML produced by these styles better
conform to XHTML rules.
2003-08-05 03:45:37 +00:00
Raymond Hettinger 4ee2ff36d0 Clarified that TypeErrors can be raised by any
function (not just builtins).

The issue arose in a thread on comp.lang.python.
2003-08-04 08:33:50 +00:00
Raymond Hettinger eaef615116 As discussed on python-dev, changed builtin.zip() to handle zero arguments
by returning an empty list instead of raising a TypeError.
2003-08-02 07:42:57 +00:00
Skip Montanaro 3576f0a6a4 Everyone knows what Fred meant, but I thought I'd make it official... ;-) 2003-07-31 01:17:22 +00:00
Fred Drake 7d597d911f Generalize the template for the "What's New" document so it's easier
to extract next time without having to remember where in CVS to dig it
out.
2003-07-30 23:52:16 +00:00
Fred Drake 90b20494a1 there's a new "What's New" for Python 2.4 2003-07-30 19:14:54 +00:00
Fred Drake ed0fa3da9f boilerplate to start off "What's New in Python 2.4" 2003-07-30 19:14:09 +00:00
Fred Drake afc0d8e893 Update to the same version info used by the interpreter. 2003-07-30 18:43:28 +00:00
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