Commit Graph

7708 Commits

Author SHA1 Message Date
Raymond Hettinger 29eb40c365 Fix nit. 2004-12-01 04:22:38 +00:00
Andrew M. Kuchling 3805fe7768 Mention getservbyport(). There's no patch number in the CVS log, so I assume Barry wrote the code. 2004-12-01 00:57:12 +00:00
Andrew M. Kuchling aafdc9cb92 Bump version number 2004-12-01 00:46:33 +00:00
Andrew M. Kuchling e2a66bf6f8 Remove mention of Template being a subclass of unicode 2004-12-01 00:45:15 +00:00
Andrew M. Kuchling b69c49c2f1 [Patch #1076365] Correction of name of Template class; add contributor 2004-12-01 00:42:41 +00:00
Peter Astrand 6fdf3cbb13 Corrected example for replacing shell pipeline. Fixes bug 1073790. 2004-11-30 18:06:42 +00:00
Andrew M. Kuchling 4871535cfe Update release date. 2004-11-30 14:42:24 +00:00
Michael W. Hudson 02d74f68c6 Hear the #error: change the default value of the mutable_arg argument
to ioctl() and remove the warning when it is not supplied.
2004-11-30 14:31:54 +00:00
Fred Drake 6e3fa2911d REVERT revision 1.260; the trunk is FROZEN.
This change can be made on the trunk and release24-maint branch after
the trunk is unfrozen.
2004-11-29 13:12:44 +00:00
Raymond Hettinger a98825ce48 Fix a nit. 2004-11-29 08:53:14 +00:00
Raymond Hettinger 4fd38b3f77 Fix typo. 2004-11-25 05:35:32 +00:00
Raymond Hettinger 23ce5848aa Clarify the ordering of dictionary keys. 2004-11-25 05:16:19 +00:00
Raymond Hettinger 3de9aa40ec Make sure the money formatting recipe can doesn't run out of digits
to the right of the decimal point.
2004-11-25 04:47:09 +00:00
Andrew M. Kuchling 536183b021 Following a LtU thread, change introductory paragraph of decimal section 2004-11-25 01:15:25 +00:00
Fred Drake f8c6e6a16b add missing dependency 2004-11-24 14:57:04 +00:00
Raymond Hettinger 8f2c4eed93 SF bug #1071566: moneyfmt recipe in decimal documentation has error 2004-11-24 05:53:26 +00:00
Tim Peters 7f13cfa674 os.walk(): Changed the "sum of bytes consumed by files" example to use
a generator expression instead of a listcomp.

Not a backport candidate (genexps are new in 2.4).
2004-11-22 16:53:46 +00:00
Tim Peters 919a3b40f9 SF bug 1071087: os.walk example for deleting a full tree is sometime wrong.
Clarify that the example assumes no links are present; the point of the
example is to illustrate a need for topdown=False, not to wrestle with
platform-dependent link convolutions.

Also spell os.path.join() out in full, instead of using a shortcut import.
The bug reporter was confused by that too, and it's clearer this way.

Bugfix candidate; but I don't intend to backport it.
2004-11-22 16:49:02 +00:00
Marc-André Lemburg a9cadcd41b Correct the handling of 0-termination of PyUnicode_AsWideChar()
and its usage in PyLocale_strcoll().

Clarify the documentation on this.

Thanks to Andreas Degert for pointing this out.
2004-11-22 13:02:31 +00:00
Facundo Batista 139af0295c Fixed quantize syntax. 2004-11-20 00:33:51 +00:00
Andrew M. Kuchling bae8f377d3 Fill in the benchmark figures, bogus or not; add a disclaimer 2004-11-19 14:55:28 +00:00
Andrew M. Kuchling 067947e840 Last pass to fill in contributor names; remove stray 'contributed by' from the incompatible changes section; remove some XXX comments 2004-11-19 14:43:36 +00:00
Andrew M. Kuchling c64be941e7 It's GTK+, apparently; remove XXX comment 2004-11-19 14:27:54 +00:00
Andrew M. Kuchling 7466659e83 Bump version number; update patch/bug counts; bet that the final release will be in December 2004-11-19 14:26:23 +00:00
Raymond Hettinger a2325f67a1 SF patch #1068456: small update for pdb docs 2004-11-18 08:39:33 +00:00
Raymond Hettinger 2a216794f0 SF bug #1066036: Typo about PyErr_WriteUnraisable() 2004-11-18 06:50:19 +00:00
Raymond Hettinger 83e4a146db SF bug #1067018: Obsolete info in Tutorial 9.1
Removed a section that is out of date after type/class unification.
While there was still some validity, the paragraph offered more
confusion that insight.
2004-11-18 06:20:30 +00:00
Raymond Hettinger 88c2595bf6 SF bug #1067023: A small typo
Make a minor clarification between "written" and "displayed".
2004-11-18 06:14:27 +00:00
Raymond Hettinger b2d5a8efd5 Comment for performance measurement. 2004-11-18 05:51:53 +00:00
Tim Peters fdc58f2391 SF bug 1066438: datetime.replace method description error
Repair typo in example.
2004-11-15 03:50:16 +00:00
Fred Drake 58954813ce avoid applying :active to anchors that are only link targets
(no href attribute)
2004-11-13 21:58:01 +00:00
Fred Drake 1681b62251 add another way to specify an alternate name for the documentation set,
so that this is harder to forget to do for development of new styles
2004-11-13 17:45:39 +00:00
Fred Drake deb39b5fef if we treat \LaTeX specially, we need to do the same for \TeX 2004-11-13 05:46:18 +00:00
Fred Drake 64f164e08f - wrap a long line
- add directory information for the "What's New" document
2004-11-13 04:41:01 +00:00
Fred Drake 9103ec5afd avoid the inane markup generated by LaTeX2HTML for \LaTeX; that simply
doesn't look right in HTML
2004-11-13 01:20:24 +00:00
Facundo Batista 441609466b SF bug 1060644. Better explanation of min() and max() methods. Thanks Raymond Hettinger and Tim Peters. 2004-11-12 02:03:36 +00:00
Greg Ward 961eda7ad9 SF #1063757: fix markup error (had LaTeX markup in the reST source,
oops!).
2004-11-12 01:20:17 +00:00
Vinay Sajip edde492f13 Minor grammatical errors fixed 2004-11-11 13:54:48 +00:00
Fred Drake af305b1dab remove some generated cruft now that we avoid the removal of elements
with no content (due to the text_cleanup() override in l2hinit.perl)
2004-11-11 08:05:34 +00:00
Fred Drake 2269d86598 Fix SF bug #1061770: Manual typesets bit-shift operators as guillemet 2004-11-11 06:14:05 +00:00
Fred Drake c6864832d7 add a comment explaining a particular text transformation 2004-11-11 05:42:13 +00:00
Fred Drake 758f5ea419 Replace last two uses of the "list" environment with "description"
environments.

Closes SF bug #692442: Konqueror can't render docs because of
malformed HTML.  While the generated HTML is still terrible, the cited
cases of <DL COMPACT> have been removed.  The general problem of XHTML
conformance has not been solved, but is endemic to LaTeX2HTML output.
2004-11-11 05:04:55 +00:00
Fred Drake 52c937dc09 remove unhelpful property setting that overrides the right setting for
text-align in .realtable cells; fix suggested by Richard Brodie
2004-11-11 04:41:24 +00:00
Fred Drake 8efc80a909 - remove use of a "list" environment (replace with a table)
- fix minor markup nits
2004-11-11 04:39:56 +00:00
Fred Drake 0a3c818fc5 - hack for MSIE5 to make (real) tables center
- remove last <center> element (long deprecated in HTML)
2004-11-10 19:22:05 +00:00
Fred Drake 9c8149a162 more HTML styling detail changes 2004-11-10 17:56:29 +00:00
Fred Drake 5d93eef263 move table formatting for grammar productions from HTML to CSS 2004-11-10 17:02:43 +00:00
Fred Drake 5b00059110 minor markup nits; fix missing whitespace 2004-11-10 16:51:17 +00:00
Fred Drake 179b39ab9e remove unreachable cruft 2004-11-10 15:54:46 +00:00
Fred Drake 9e927f1564 add a comment about one of the remaining warts in the table
formatting
2004-11-10 15:49:25 +00:00
Fred Drake b194b5b3cc remove comment that seems to be wrong after all; browsers do implement
this, but I was misled by a LaTeX2HTML wart that I worked around
yesterday
2004-11-10 15:39:50 +00:00
Fred Drake 39a6a6d3c8 move much of the table styling out of the HTML and into the CSS;
this also makes some constructs more XHTML friendly (including adding in
some missing </tr> tags)
2004-11-10 15:37:54 +00:00
Fred Drake 0cf87be326 more more styling to the CSS 2004-11-10 08:08:26 +00:00
Fred Drake d7a5bca89b more XHTML friendliness: <dl compact> becomes well-formed 2004-11-10 08:07:00 +00:00
Fred Drake dcb16ac03c override a bit of LaTeX2HTML so empty table cells don't disappear from
the output
2004-11-10 07:48:17 +00:00
Andrew M. Kuchling f8c075cefc Bump version number
Add doctest section
Wordsmithing
2004-11-09 02:58:02 +00:00
Johannes Gijsbers 4de9374b0e Patch #1062033 / bug #1027771: clarify what happens when calling
insertBefore() with refChild=None.
2004-11-07 19:55:18 +00:00
Johannes Gijsbers 4f18caa07b Patch #1062018 / bug #1038693: comment out dead link in tkinter docs. 2004-11-07 19:36:48 +00:00
Peter Astrand 3546188123 Added more documentation about the executable argument.
Fixes #1056441.
2004-11-07 16:38:08 +00:00
Johannes Gijsbers f164322fe8 Patch #1061924: add documentation for BaseRotatingHandler and correct
reference to non-existent function 'setRollover()'.
2004-11-07 16:11:35 +00:00
Johannes Gijsbers eaaa771816 Clarify that it's not necessary to subclass from TestCase to create a
test case. As Jeremy put it: "subclassing is an implementation
technique, not a type declaration".
2004-11-07 16:02:07 +00:00
Johannes Gijsbers 4f802ac2b6 Patch #1061857: add documentation for previously undocumented
TimedRotatingFileHandler class. Thanks Jeroen Vloothuis!
2004-11-07 14:14:27 +00:00
Raymond Hettinger 700d9b9b63 SF patch #1061780: use a new -m option in pdb and profile invocations
Doc patch submitted by Ilya Sandler.
2004-11-07 06:18:37 +00:00
Raymond Hettinger bb4e859ecf SF bug #1060825: Error in difflib docs 2004-11-05 16:38:08 +00:00
Fred Drake e0bdaefaf4 - remove some bogus <meta> tags from the document head
- clean up some of the generated markup
2004-11-05 06:42:22 +00:00
Fred Drake 0384be3b07 generate the "type" attribute on the favicon link 2004-11-05 05:06:08 +00:00
Fred Drake 6e2e90d160 switch remaining icon references to the PNG icons 2004-11-05 04:51:05 +00:00
Fred Drake 8aebe19e35 add encouragement to contribute without learning LaTeX
(closes SF bug #948517)
2004-11-05 04:23:25 +00:00
Fred Drake 5c0ebdcb64 - make the default image type PNG, to match mkhowto
- add a command-line option to control the image type
2004-11-05 04:05:06 +00:00
Tim Peters 2cf5e1920b Point out some platform vagaries in stat() and utime().
Bugfix candidate (the vagaries aren't new <wink>), but I don't intend to
backport this.
2004-11-04 21:27:48 +00:00
Armin Rigo 80adba6873 Mistakes in the "sequence types" page:
* explanation for example with lists of lists made confusing use of
  the word "contains" to mean "is built out of".

* wrong formula for slices with step.  Is it ok to use LaTeX formulas
  (which become images in the html document)?  This version needs one
  because it's based on a fraction.  Just writing "\code{(j-i)/k}" here would
  be ambiguous because it looks like a rounding-down-to-the-previous-integer
  division, which is not what we need here.  Of course we could write
  "\code{float(j-i)/k}" but it just looks confusing.
2004-11-04 11:29:09 +00:00
Fred Drake 99e5ce5cf4 markup nit 2004-11-04 05:45:44 +00:00
Skip Montanaro 599bd5e1e1 Fix bug 1052242. Also includes rewrite of test case using unittest and
avoiding use of popen.
2004-11-04 04:31:30 +00:00
Fred Drake ed306292d6 fix markup in "title" attribute for \citetitle{}
(closes SF patch #1054715; backporting to release23-maint branch)
2004-11-04 03:23:04 +00:00
Fred Drake eac00edd20 fix accidental commit 2004-11-02 19:20:43 +00:00
Fred Drake 7fabaf8375 clarify discussion of iteration in the section on the "for" statement
(SF bug #829073)
2004-11-02 19:18:20 +00:00
Fred Drake 303e30ef9f clarify discussion of iteration in the section on the "for" statement
(SF bug #829073)
2004-11-02 19:18:20 +00:00
Fred Drake 9a40851569 clarify trailing comma in function argument list
(SF bug #798652)
2004-11-02 18:57:33 +00:00
Fred Drake e808c2341b - show how to use file.write() with a non-string value
(closes SF bug #621057)
- add missing whitespace around assignment operator
2004-11-02 18:24:26 +00:00
Barry Warsaw 87d6fc5161 SF bug #1030118, this should have named the email.Utils module as the one
containing these functions.  (I will backport to Python 2.3)
2004-11-01 03:59:24 +00:00
Barry Warsaw 8c72eae237 SF patch #1056967, changes the semantics of Template.safe_substitute() to not
raise a ValueError for dangling delimiters (the delimiter itself is returned).
2004-11-01 03:52:43 +00:00
Johannes Gijsbers 63e2090fda Bug #1057535: add link in time module to calendar.timegm(). 2004-10-31 12:19:34 +00:00
Fred Drake 0c1b253fc0 add xml:id attributes wherever we generate the IDs (old patch saved up) 2004-10-29 19:47:52 +00:00
Fred Drake 048840c485 style consistency:
- always include a space after the "#" that starts a comment
- easier to read imports
2004-10-29 14:35:42 +00:00
Vinay Sajip 006483b003 Added network logging example 2004-10-29 12:30:28 +00:00
Hye-Shik Chang 182ac85147 SF #737473: Show up-to-date source code in tracebacks always.
And add an optional argument 'filename' to linecache.checkcache()
to enable checking caches per-file.
2004-10-26 09:16:42 +00:00
Raymond Hettinger df8a0032a4 SF 1053956: help() not in tutorial index 2004-10-26 03:53:35 +00:00
Fred Drake 3ed238503d add missing line break 2004-10-25 21:35:17 +00:00
Fred Drake afe73c02a9 - improve the explanation of the -*- coding: ... -*- marker
- fix a minor formatting nit that affected the typeset version
2004-10-25 16:03:49 +00:00
Vinay Sajip 93ae4c100e Added example of multiple destinations 2004-10-22 21:43:15 +00:00
Andrew M. Kuchling 57712b3d9a Remove the current version of zlib (we'll just have to keep updating it); rewrite following sentence to make sense without the previous one 2004-10-19 19:50:23 +00:00
Andrew M. Kuchling 28d07ab676 Typo fixes, and a minor edit to clarify a sentence 2004-10-19 19:39:02 +00:00
Andrew M. Kuchling 5fcc003566 [Bug #1049826] Update version of zlib referenced in text 2004-10-19 18:52:49 +00:00
Fred Drake 972c9e85bb Rely on the style sheet more for the distutils markup. 2004-10-19 15:40:38 +00:00
Fred Drake 20a175a34a made it clear that this isn't a complete reference to
LaTeX-as-used-in-Python-documentation, and added some notes about
what's missing
2004-10-18 21:30:40 +00:00
Andrew M. Kuchling 8b94dc6d07 Bump version 2004-10-18 16:16:53 +00:00
Brett Cannon 6b1597c7c7 Clarify note about using %U and %W with strptime(). 2004-10-18 01:53:15 +00:00
Brett Cannon 8abcc5d533 Add support for %U and %W to contribute to calculating the date when the year
and day of the week are specified.

Closes bug #1045381.
2004-10-18 01:37:57 +00:00
Neal Norwitz a5c64599d5 SF bug #1048756, Doc typo for pdb 2004-10-17 19:55:47 +00:00
Neal Norwitz 2562ff2de3 SF patch #1047577, typo in liblocale.tex 2004-10-17 16:36:05 +00:00
Fredrik Lundh b04b6afd01 SF Patch #1048341: subprocess documentation, based on PEP/docstring by
Peter Astrand, with markup by Fredrik Lundh and Raymond Hettinger.
2004-10-17 16:29:48 +00:00
Facundo Batista 2784df7502 SF Bug #1046800: Importing Tkinter correctly (thanks Vishnu). 2004-10-16 21:40:35 +00:00
Tim Peters 371e4d895b SF bug 1046690: difflib.HtmlDiff doc errors.
Easy doc corrections from Dan Gass.
Also repaired the LaTeX for optional keyword arguments throughout, which
was (incorrectly) nested instead of flat.
2004-10-14 03:09:48 +00:00
Andrew M. Kuchling b6ffc275ab Finish off PEP 324 section; fix Peter's last name 2004-10-12 16:36:57 +00:00
Andrew M. Kuchling c9e7d77aaa Start section for PEP 324 2004-10-12 15:58:02 +00:00
Andrew M. Kuchling f3958f16cf Add two items 2004-10-11 19:20:06 +00:00
Johannes Gijsbers 9fc9789a0d Document that on Unix, the 'cmd' argument to the os.popen2/3/4 and
popen2.popen2/3/4 functions can be a sequence. All texts are a variation on the
following:

On \UNIX, \var{cmd} may be a sequence, in which case arguments will be passed
directly to the program without shell intervention (as with
\function{os.spawnv()}). If \var{cmd} is a string it will be passed to the shell
(as with \function{os.system()}).
2004-10-11 18:12:20 +00:00
Anthony Baxter 3dd9e46161 Added a usegmt flag to email.Utils.formatdate - this allows it to be
used to replace rfc822.formatdate for protocols like HTTP (where 'GMT' must
be the timezone string).
2004-10-11 13:53:08 +00:00
Tim Peters 7f468f29f4 SF patch 1044089: New C API function PyEval_ThreadsInitialized(), by Nick
Coghlan, for determining whether PyEval_InitThreads() has been called.
Also purged the undocumented+unused _PyThread_Started int.
2004-10-11 02:40:51 +00:00
Johannes Gijsbers 7126976ee8 Patch #1042969: add closing brace for \token {generator_expression}. Thanks
George Yoshida!
2004-10-09 15:52:04 +00:00
Andrew M. Kuchling 7a8ce5afcc [Bug #1022311] curses module uses y,x ordering of arguments, not x,y 2004-10-08 18:48:43 +00:00
Andrew M. Kuchling 293dc9d70f [Bug #1041501] Fix example code 2004-10-08 18:34:47 +00:00
Andrew M. Kuchling cebdd3c8f1 [Bug #1031897] Fix order of decorator application 2004-10-08 18:29:29 +00:00
Raymond Hettinger 77d110d6b8 SF patch #1041364: True/False instead of 1/0 in libstdtypes.tex
(Contributed by Gerrit Holl.  Reviewed by Jeff Epler.)
2004-10-08 01:52:15 +00:00
Andrew M. Kuchling 5e3f9236c7 Add item 2004-10-07 12:00:33 +00:00
Raymond Hettinger db29e0fe8c SF patch #1035498: -m option to run a module as a script
(Contributed by Nick Coghlan.)
2004-10-07 06:46:25 +00:00
Andrew M. Kuchling 579b3e2416 Add some items 2004-10-05 20:23:34 +00:00
Tim Peters 29978aedcb The docs claimed a test would pass that actually wouldn't pass. Repaired
the example so it does pass.
2004-10-04 03:34:32 +00:00
Vinay Sajip 1dc5b1e5a2 Clarified documentation about exc_info keyword parameter 2004-10-03 19:10:05 +00:00
David Goodger 1cbf206d32 SF bug #997050: Document, test, & check for non-string values in ConfigParser. Moved the new string-only restriction added in rev. 1.65 to the SafeConfigParser class, leaving existing ConfigParser & RawConfigParser behavior alone, and documented the conditions under which non-string values work. 2004-10-03 15:55:09 +00:00
Michael W. Hudson bfe5684308 typo 2004-10-03 09:41:26 +00:00
Barry Warsaw 8df5921247 Blarg, fix the versions. 2004-10-03 03:58:01 +00:00
Barry Warsaw 43790b4b21 Updates for distutils package. 2004-10-03 03:57:37 +00:00
Barry Warsaw 2ec4854f13 Add documentation about as_string() mangling From_ lines. 2004-10-03 03:39:47 +00:00
Barry Warsaw bb11386730 Big email 3.0 API changes, with updated unit tests and documentation.
Briefly (from the NEWS file):

- Updates for the email package:
  + All deprecated APIs that in email 2.x issued warnings have been removed:
    _encoder argument to the MIMEText constructor, Message.add_payload(),
    Utils.dump_address_pair(), Utils.decode(), Utils.encode()
  + New deprecations: Generator.__call__(), Message.get_type(),
    Message.get_main_type(), Message.get_subtype(), the 'strict' argument to
    the Parser constructor.  These will be removed in email 3.1.
  + Support for Python earlier than 2.3 has been removed (see PEP 291).
  + All defect classes have been renamed to end in 'Defect'.
  + Some FeedParser fixes; also a MultipartInvariantViolationDefect will be
    added to messages that claim to be multipart but really aren't.
  + Updates to documentation.
2004-10-03 03:16:19 +00:00
Raymond Hettinger 565ea5ae37 SF bug#1038917 fix typos (Contributed by George Yoshida.) 2004-10-02 11:02:59 +00:00
Greg Ward e644a1b921 Get references working (except for references to "Extending optparse",
which isn't being converted from reST yet).
2004-10-01 01:16:39 +00:00
Edward Loper 0fe00aafc3 Added 2 notes about the complexities of testing SyntaxErrors. 2004-09-30 17:18:18 +00:00
Raymond Hettinger f751fa6195 SF bug #1035279: hex() and oct() documentation is incorrect
* Updated docs to reflected signed return values.
* Fixed a doubled word typo.
2004-09-30 00:59:08 +00:00
Nicholas Bastin 975e725fc7 Fix typo in PyDict_Items doc 2004-09-29 21:39:26 +00:00
Skip Montanaro 5497feefac minor doc tweaks for writexml 2004-09-28 18:40:42 +00:00
Skip Montanaro 67db9a5b72 typo 2004-09-28 18:30:03 +00:00
Tim Peters 01ba799244 A number of list examples used 66.6, but I doubt there's any box on which
repr(66.6) == "66.6", so doubt that the claimed output has ever been seen.
Changed it to 66.25 everywhere, and manually verified that the new claimed
output is correct.
2004-09-28 16:12:50 +00:00
Edward Loper 7d88a58e85 Reverted the addition of a NORMALIZE_NUMBERS option, per Tim Peter's
request.  Tim says that "correct 'fuzzy' comparison of floats cannot
be automated."  (The motivation behind adding the new option
was verifying interactive examples in Python's latex documentation;
several such examples use numbers that don't print consistently on
different platforms.)
2004-09-28 05:50:57 +00:00
Edward Loper aec3c9b54f Added a new NORMALIZE_NUMBERS option, which causes number literals in
the expected output to match corresponding number literals in the
actual output if their values are equal (to ten digits of precision).
2004-09-28 04:29:57 +00:00
Edward Loper 1793dd31de Fixed minor typo in interactive example (extra '.'s in '...' prompts) 2004-09-28 03:12:01 +00:00
Edward Loper dcdb4b4d78 Fixed minor typo in interactive example (extra blank line) 2004-09-28 03:08:57 +00:00
Raymond Hettinger 78a5271d3e SF bug #1033038: Misleading error message in random.choice
Added a clarifying line to the docs.
2004-09-28 03:04:23 +00:00
Edward Loper ad512265a5 Fixed minor typo in interactive example 2004-09-28 02:56:45 +00:00
Edward Loper 3077b02ff4 Fixed minor typo in interactive example (backslash shouldn't be doubled) 2004-09-28 02:54:54 +00:00
Edward Loper a7f62814cf Updated interactive examples in the "Examples" session to reflect the
fact that compiler.ast.Function now takes a "decorators" argument.
2004-09-28 02:53:50 +00:00
Greg Ward b6f7fb7327 Major overhaul to reflect Optik 1.5. Section references currently broken. 2004-09-28 01:30:23 +00:00
Armin Rigo b6aa856f25 Patch #1009075, bug #952953: allow execve with empty 2nd argument 2004-09-27 19:54:33 +00:00
Edward Loper a4c6a8522c - Added a "parser" option to testfile() and DocFileTest(). 2004-09-27 04:08:20 +00:00
Edward Loper 456ff91664 - Fixed typo in multi-line exception example
- Fixed indentation for a verbatim block
2004-09-27 03:30:44 +00:00
Tim Peters 36ee8ce373 Give a saner example for script_from_examples(); also mention an intended
but not entirely obvious use case.
2004-09-26 21:51:25 +00:00
Tim Peters 9463d8761b Made most module references "clickable". 2004-09-26 21:05:03 +00:00
Tim Peters 0041121c25 Docs for run_docstring_examples(). 2004-09-26 20:45:04 +00:00
Tim Peters 05b05febad Added a lot of new stuff to the debugging section. 2004-09-26 05:09:59 +00:00
Tim Peters 16be62f054 register_optionflag(): Moved from the Debugging section to the section
on option flags; added a versionadded decoration.
2004-09-26 02:38:41 +00:00
Tim Peters 6a0a64b7ad Document set_unittest_reportflags(). 2004-09-26 02:12:40 +00:00
Raymond Hettinger c90ea82302 Fix double word error. 2004-09-25 08:09:23 +00:00
Tim Peters 3f7912521d Assorted minor changes, plus a lot more soap. 2004-09-25 03:50:35 +00:00
Tim Peters 8c0a2cf938 Explain the motivation for the unittest functions, and beef up the
example.  Squash repeated argument descriptions.  Minor rewordings.
2004-09-25 03:02:23 +00:00
Tim Peters b2b26aca13 Repaired mistakes in the descriptions of testmod()/testfile(), and
squashed massive duplication of common argument descriptions.
2004-09-25 01:51:49 +00:00
Tim Peters 2dc820599b Since the doctest warnings section was reduced to one bullet point,
get rid of the itemize structure.
2004-09-25 01:30:16 +00:00
Tim Peters 39c5de0376 In the "doctest warnings" section, removed obsolete info, and noted that
ELLIPSIS can be used to deal with examples that embed object addresses.
2004-09-25 01:22:29 +00:00
Johannes Gijsbers 24f141ab46 Raymond observed that sometimes it's better not to link modules, so I reverted
part of my previous last changes.
2004-09-25 00:55:38 +00:00
Tim Peters 06cc847cee Beef up the section on testfile(), giving a complete example in
reStructuredText format.  Remove words describing the return value of
testmod() and testfile() in the intro sections, since it's never
useful in such simple cases.
2004-09-25 00:49:53 +00:00
Tim Peters cac5e7b81d Typo. 2004-09-25 00:11:43 +00:00
Tim Peters 7a082142d8 Since the LaTeX isn't doctest'ed, examples are always wrong <wink>. 2004-09-25 00:10:53 +00:00
Johannes Gijsbers 27ebcae450 - Use itemize instead of plain-text '*' for marking up a list.
- Add more ulink's to modules (this should probably become a standard macro).
2004-09-24 23:25:25 +00:00
Vinay Sajip 739d49e39b Added log() function documentation 2004-09-24 11:46:44 +00:00
Raymond Hettinger 596ba4d89e Granted Noam Raphael's request for minor improvements to the re module and
its documentation.

* Documented that the compiled re methods are supposed to be more full
  featured than their simpilified function counterparts.

* Documented the existing start and stop position arguments for the
  findall() and finditer() methods of compiled regular expression objects.

* Added an optional flags argument to the re.findall() and re.finditer()
  functions.  This aligns their API with that for re.search() and
  re.match().
2004-09-24 03:41:05 +00:00
Andrew M. Kuchling 9fa544cfa3 Update for beta1 2004-09-23 20:17:26 +00:00
Andrew M. Kuchling 0c7895617f Add various items 2004-09-23 20:15:41 +00:00
Raymond Hettinger 4533f1fb7f Improve three recipes in the itertools docs. 2004-09-23 07:27:39 +00:00
Vinay Sajip c6646c097a Added getLoggerClass() 2004-09-22 12:55:16 +00:00
Edward Loper b3666a3da2 - Updated docs to reflect changes in 2.4.
- Reorganized the documentation
  - Shifted focus a little more towards "literate testing"
  - Documented new functions and classes:
    - testfile()
    - Example, DocTest
    - DocTestParser, DocTestFinder, DocTestRunner, OutputChecker
    - DocFileSuite
    - DebugRunner, DocTestFailure, UnexpectedException
    - register_optionflag()
2004-09-21 03:00:51 +00:00
Raymond Hettinger 468af71214 Fix minor grammar typo. 2004-09-20 17:47:46 +00:00
Edward Loper 6cc1350807 - Updated example output to match actual output
- Minor wording changes
- Changed the docs to reflect the fact that multiple option directives
  can be specified on a single line (and updated the directive
  production list, as well).
2004-09-19 01:16:44 +00:00
Barry Warsaw 33db656dbf Update Template/PEP 292 documentation to current implementation. 2004-09-18 21:13:43 +00:00
Martin v. Löwis 39a317890f Patch #1025790: Add status code constants to httplib. 2004-09-18 09:03:49 +00:00
Fred Drake 2e6fb4634c remove gzipped archives from the list of expected distributions 2004-09-17 20:23:47 +00:00
Martin v. Löwis 266a436fe2 Remove claims that Python source code is ASCII. Fixes #1026038. 2004-09-14 07:52:22 +00:00
Raymond Hettinger 879ddf30d0 Tweak the wording. Improve examples. Make more brief. 2004-09-14 06:32:20 +00:00
Raymond Hettinger 29c6a79b7d Cover string.Template in the tutorial's library tour. 2004-09-14 05:21:42 +00:00
Raymond Hettinger 23f1241dc6 SF #1027105: HardwareRandom should be renamed OSRandom
Renamed the new generator at Trevor's recommendation.
The name HardwareRandom suggested a bit more than it
delivered (no radioactive decay detectors or such).
2004-09-13 22:23:21 +00:00
Andrew M. Kuchling 7642f7af0d Credit patch from Raymond 2004-09-13 15:06:50 +00:00
Tim Peters 8278860e52 Document testmod's new exclude_empty argument. 2004-09-13 15:03:17 +00:00
Tim Peters 2ee8099bd8 HtmlDiff corrections from Dan Gass, + trimmed trailing whitespace. 2004-09-12 03:21:00 +00:00
Johannes Gijsbers 6ab4b99f95 Patch #1025795: clarify language in Data Structures chapter of tutorial:
- Dictionary keys are in arbitrary order, but not random (which implies, well,
  intentional randomness).
- Move a footnote closer to what it's talking about so that it doesn't look
  like we're saying that "0 == 0.0" can't be relied on.
- Minor language tweaks in the vicinity.

Thanks Dima Dorfman!
2004-09-11 17:48:21 +00:00
Johannes Gijsbers 2014c033f7 Patch #1022152: add required 'domain' argument to gettext.translation() examples. 2004-09-11 17:33:25 +00:00
Johannes Gijsbers d345225ae5 Patch #1026384: fix two common typo's:
- accomodate -> accommodate
- occured -> occurred

Thanks George Yoshida!
2004-09-11 16:50:06 +00:00
Johannes Gijsbers c9c37ca62e Patch #1025800: remove TeX quoting from verbatim section. Thanks Dima Dorfman! 2004-09-11 15:47:30 +00:00
Andrew M. Kuchling f08437ca08 [Bug #1023359] Make code match inheritance diagram 2004-09-10 19:33:00 +00:00
Andrew M. Kuchling a331e86452 Add some stdlib items; remove 'other changes' section; fix sorting error in list of changed modules 2004-09-10 13:05:22 +00:00
Andrew M. Kuchling 55be9eab38 Typo fix: 'comparisions' is not a word 2004-09-10 12:59:54 +00:00
Andrew M. Kuchling 2cc0c3008c Bump version number 2004-09-10 12:38:36 +00:00
Andrew M. Kuchling a79ec22f9f Update PEP292 section 2004-09-10 11:34:39 +00:00
Fred Drake 961c2882a9 document the exceptions raised by sgmllib, htmllib, and HTMLParser 2004-09-10 01:20:21 +00:00
Fred Drake a2544ee7f0 fix typo in markup 2004-09-10 01:16:49 +00:00
Fred Drake 216b249e94 make_nav_panel(): Don't cause side-effects on the input variables;
this caused duplicate attributes for the bottom navigation panel.

(closes SF patch #1013055; backport candidate)
2004-09-09 05:13:52 +00:00
Walter Dörwald 69652035bc SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
decoding incomplete input (when the input stream is temporarily exhausted).
codecs.StreamReader now implements buffering, which enables proper
readline support for the UTF-16 decoders. codecs.StreamReader.read()
has a new argument chars which specifies the number of characters to
return. codecs.StreamReader.readline() and codecs.StreamReader.readlines()
have a new argument keepends. Trailing "\n"s will be stripped from the lines
if keepends is false. Added C APIs PyUnicode_DecodeUTF8Stateful and
PyUnicode_DecodeUTF16Stateful.
2004-09-07 20:24:22 +00:00
Raymond Hettinger 8158e84930 Fix erroneous docstring comment. 2004-09-06 07:04:09 +00:00
Raymond Hettinger 785c65ccd2 Markup nits. 2004-09-06 01:01:08 +00:00
Raymond Hettinger bb30af4565 Add missing close parenthesis. 2004-09-06 00:42:14 +00:00
Raymond Hettinger 18c6960964 SF bug #901654: split method documentation can be improved
* Discuss the algorithmic distinctions between s.split() and s.split(sep).
* Document the split behavior for empty strings.
* Note the behavior when maxsplit is zero.
* Include short examples.
2004-09-06 00:12:04 +00:00
Brett Cannon 1b262977a0 Rework some wording. 2004-09-05 19:42:15 +00:00
Raymond Hettinger 2a72f19528 SF bug #1020540: a wrong link from "frame object" in lib index 2004-09-04 21:14:34 +00:00
Tim Peters 1fbf9c5ec1 Added IGNORE_EXCEPTION_DETAIL comparison option. The need is explained
in the new docs.

DocTestRunner.__run:  Separate the determination of the example outcome
from reporting that outcome, to squash brittle code duplication and
excessive nesting.
2004-09-04 17:21:02 +00:00
Gustavo Niemeyer a01a2ee933 Applying modified version of patch #1018386, which fixes
some escaping bugs in SRE.
2004-09-03 17:06:10 +00:00
Skip Montanaro 0bbf137fbd Make the api of the _dispatch() method more concrete. I have no idea if
this is the right way to document such things (Fred, help me out here :-),
but I got misled by the existing documentation and assumed the parameter
list was a *args sort of thing.
2004-09-03 00:04:05 +00:00
Fred Drake 410eb84a5d - add missing \end{seealso}
- wrap long line
2004-09-01 04:05:08 +00:00
Andrew M. Kuchling 3d3db9663f Add item 2004-08-31 13:57:02 +00:00
Andrew M. Kuchling ecd5754925 Remove rotor reference 2004-08-31 13:49:36 +00:00
Andrew M. Kuchling 595ac8a6fc Remove rotor license 2004-08-31 13:24:08 +00:00
Andrew M. Kuchling ab459f71d6 Remove docs for xreadlines, mpz, rotor 2004-08-31 13:22:43 +00:00
Andrew M. Kuchling e723863ba1 Remove xreadlines reference 2004-08-31 13:21:07 +00:00
Andrew M. Kuchling a46fd8480f Remove TERMIOS docs 2004-08-31 13:05:59 +00:00
Andrew M. Kuchling e4133d8d67 Use correct constant; remove reference to TERMIOS.py 2004-08-31 13:05:36 +00:00
Andrew M. Kuchling e34c3bd621 Change from Raymond: use pos/neg instead of +/- 1; minor edits 2004-08-31 12:21:44 +00:00
Andrew M. Kuchling ab77822826 Describe non-recursive re 2004-08-31 12:07:43 +00:00
Andrew M. Kuchling b07aae28c5 Add bug/patch counts 2004-08-31 11:54:22 +00:00
Andrew M. Kuchling 3294e9d2e7 Update versions and dates; add PEP 328 2004-08-31 11:26:23 +00:00
Vinay Sajip 17952b78e1 Updated doc for getLogger() 2004-08-31 10:21:51 +00:00
Anthony Baxter 1a4ddaecc7 SF patch #1007189, multi-line imports, for instance:
"from blah import (foo, bar
baz, bongo)"
2004-08-31 10:07:13 +00:00
Tim Peters 38330fe5ef The distinction between comparison flags and reporting flags isn't unique
to unittest, so make it official:  new module constants COMPARISON_FLAGS
and REPORTING_FLAGS, which are bitmasks or'ing together the relevant
individual option flags.

set_unittest_reportflags():  Reworked to use REPORTING_FLAGS, and
simplified overly complicated flag logic.

class FakeModule:  Removed this; neither documented nor used.
2004-08-30 16:19:24 +00:00
Johannes Gijsbers ed047486f5 Fix build error: \filename{/dev/urandom} -> \file{/dev/urandom}. 2004-08-30 15:03:23 +00:00
Andrew M. Kuchling cb7b3f30d6 Add items 2004-08-30 11:58:04 +00:00
Johannes Gijsbers ae882f7984 Patch #941486: add os.path.lexists(). Also fix bug #940578 by using lexists in glob.glob. 2004-08-30 10:19:56 +00:00
Raymond Hettinger 356a4599ac Teach the random module about os.urandom().
* Use it for seeding when it is available.
* Provide an alternate generator based on it.
2004-08-30 06:14:31 +00:00
Martin v. Löwis e064b41f5a Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. 2004-08-29 16:34:40 +00:00
Martin v. Löwis dc3883f671 Patch #934711: Expose platform-specific entropy. 2004-08-29 15:46:35 +00:00
Raymond Hettinger 6ab78cd0c0 SF feature request #992967: array.array objects should support sequences.
Made the constructor accept general iterables.
2004-08-29 07:50:43 +00:00
Johannes Gijsbers 592ef6110f Correct incorrect "it's" to "its". 2004-08-26 10:40:12 +00:00
Tim Peters f33683fd40 Fine tune a word. 2004-08-26 04:52:46 +00:00
Tim Peters cf53355fcf Thinko repair. 2004-08-26 04:50:38 +00:00
Tim Peters a07bcd46f3 Reorg of exception section. Now that there are fewer details needing
explanation, it's easier to push the remaining insufferably anal details
into a "fine print" section at the bottom.
2004-08-26 04:47:31 +00:00
Raymond Hettinger f4fd79ca49 Small wording fixups. 2004-08-26 03:11:56 +00:00
Edward Loper a89f88d53f Added REPORT_ONLY_FIRST_FAILURE flag, which supresses output after the
first failing example in each test.
2004-08-26 02:45:51 +00:00
Edward Loper 71f55af826 Renamed UNIFIED_DIFF->REPORT_UDIFF; CONTEXT_DIFF->REPORT_CDIFF; and
NDIFF_DIFF->REPORT_NDIFF.  This establishes the naming convention that
all reporting options should begin with "REPORT_" (since reporting
options are a different class from output comparison options; but they
are both set in optionflags).
2004-08-26 01:41:51 +00:00
Tim Peters 0e448073d6 Restored half of a \versionadded only half of which should have been
deleted.
2004-08-26 01:02:08 +00:00
Dave Cole e8bbfe4e63 Patch #1015012. Improve markup and punctuation in libsocket.tex 2004-08-26 00:51:16 +00:00
Dave Cole 3203efb55f Patch #1014930. Expose current parse location to XMLParser. 2004-08-26 00:37:31 +00:00
Edward Loper 19b1958730 Only recognize the expected output as an exception if it *starts* with
a traceback message.  I.e., examples that raise exceptions may no
longer generate pre-exception output.  This restores the behavior of
doctest in python 2.3.  The ability to check pre-exception output is
being removed because it makes the documentation simpler; and because
there are very few use cases for it.
2004-08-25 23:07:03 +00:00
Fred Drake e3a1b4888c clean up markup for --executable description 2004-08-25 14:01:32 +00:00
Andrew M. Kuchling 87c98b2e4b Add various items 2004-08-25 13:38:46 +00:00
Martin v. Löwis 9f5c0c41ce Patch #736857, #736859: Add -e option to build_scripts. 2004-08-25 11:37:43 +00:00
Martin v. Löwis be83737c7c Patch #798244: More urllib2 examples. 2004-08-25 11:24:42 +00:00
Martin v. Löwis 8d494f3241 Patch #1015021: Stop claiming that coerce can return None.
Will backport to 2.3.
2004-08-25 10:42:41 +00:00
Barry Warsaw 08b07def43 Ah whoops, we didn't turn string into a package (thanks Neal!) 2004-08-25 03:09:58 +00:00
Barry Warsaw 8bee76106e PEP 292 classes Template and SafeTemplate are added to the string module.
This patch includes test cases and documentation updates, as well as NEWS file
updates.

This patch also updates the sre modules so that they don't import the string
module, breaking direct circular imports.
2004-08-25 02:22:30 +00:00
Tim Peters c885443479 Stop producing or using OverflowWarning. PEP 237 thought this would
happen in 2.3, but nobody noticed it still was getting generated (the
warning was disabled by default).  OverflowWarning and
PyExc_OverflowWarning should be removed for 2.5, and left notes all over
saying so.
2004-08-25 02:14:08 +00:00
Dave Cole 07fda7e3a0 Updated the socketpair() docstring and documentation to explain that the
default famility is AF_UNIX if defined for the platform, otherwise the
default is AF_INET.
2004-08-23 05:16:23 +00:00
Tim Peters 656f7e4b40 Removed redundant versionadded{} for NDIFF_DIFF. Virtually everything
in this section is new in 2.4, and that's all mentioned already in
versionadded{} thingies at the end of the section.  It hurts readability
to have them after every line <wink>.
2004-08-23 00:26:42 +00:00
Neal Norwitz 8bd5cb342c Add version info 2004-08-22 21:48:37 +00:00
Tim Peters c6cbab0db4 Added NDIFF_DIFF option. 2004-08-22 19:43:28 +00:00
Raymond Hettinger d3b0babf66 SF bug #1013760: Error in Chapter 4 of Tutorial
Fit a nit.
2004-08-22 15:24:33 +00:00
Neal Norwitz 5268c3955a sf #1009373, #1005936. fix underscores in index entries in PDF files.
I couldn't test this, but it didn't break anything and the patch
reported fixed the problem.

Bugfix candidate.
2004-08-21 15:13:52 +00:00
Neal Norwitz 7109b287cf Fix grammar, spotted by Hye-Shik Chang 2004-08-20 23:13:26 +00:00
Johannes Gijsbers 8e3bec5418 Correct argument specifications of load_compiled and load_source: the file
argument is optional on both (the format string is "ss|O!").
2004-08-20 14:38:56 +00:00
Johannes Gijsbers c89061817b Quote # as \# to make lib compile again. 2004-08-20 14:37:05 +00:00
Neal Norwitz 8623b36ee0 Try to improve grammar and use versionadded 2004-08-20 02:36:27 +00:00
Neal Norwitz 525b315326 Fix markup. versionchanged automatically adds a period, so remove the extra one. 2004-08-20 01:52:42 +00:00
Tim Peters 026f8dc103 Now that they've settled down, document doctest directives. 2004-08-19 16:38:58 +00:00
Martin v. Löwis 336e85f56a Patch #900727: Add Py_InitializeEx to allow embedding without signals. 2004-08-19 11:31:58 +00:00
Fred Drake c6f3c8b612 fix SF bug #1008690: Incorrect <link rel="index"> href in Tutorial
The make_head_and_body() function used a hardcoded value for the
<link> element for the index; this patch causes the proper output
filename to be captured during the transformation phase so it can be
used during the page assembly phase.
2004-08-19 01:37:48 +00:00
Matthias Klose cf02e31683 Remove commented definition of the MKHOWTO macro. 2004-08-18 22:27:04 +00:00
Matthias Klose 5b75f7d19b Remove zero-byte gif files from generated html docs 2004-08-18 22:17:44 +00:00
Martin v. Löwis 75b9da4aaf Patch #995126: Correct directory size, and generate GNU tarfiles by default. 2004-08-18 13:57:44 +00:00
Martin v. Löwis ae075b6cb7 Patch #1011144: Correct regex for coding decls. 2004-08-18 13:25:05 +00:00
Martin v. Löwis deacce2c87 Patch #800236: add HTTPResponse.getheaders(). 2004-08-18 12:46:26 +00:00
Raymond Hettinger 01884d56f4 Deprecate sys.exitfunc in favor of the atexit module.
Per Guido, sys.exitfunc will be kept around for backwards compatability
but atexit will become the one preferred way to do it.
2004-08-18 02:50:00 +00:00
Michael W. Hudson 0ccff074cd This is Mark Russell's patch:
[ 1009560 ] Fix @decorator evaluation order

From the description:

Changes in this patch:

- Change Grammar/Grammar to require
newlines between adjacent decorators.

- Fix order of evaluation of decorators
in the C (compile.c) and python
(Lib/compiler/pycodegen.py) compilers

- Add better order of evaluation check
to test_decorators.py (test_eval_order)

- Update the decorator documentation in
the reference manual (improve description
of evaluation order and update syntax
description)

and the comment:

Used Brett's evaluation order (see
http://mail.python.org/pipermail/python-dev/2004-August/047835.html)

(I'm checking this in for Anthony who was having problems getting SF to
talk to him)
2004-08-17 17:29:16 +00:00
Raymond Hettinger 8de636e2ae SF bug #951482: New module: doc versus action
Strengthen the warnings about creating bogus objects using the new module.
2004-08-17 02:31:55 +00:00
Raymond Hettinger cb40ba1f5e SF bug #805304: super instances don't support item assignment
Document a nuance of super().  It is designed to work well with dotted
attribute lookup but not with equivalent implicit lookups using operators
or statements.
2004-08-17 02:21:45 +00:00
Andrew M. Kuchling 7ec7584813 Typo fix 2004-08-16 16:12:23 +00:00
Raymond Hettinger d3fe2395b4 Minor improvements to the threading introduction:
* Expand the example to show a join.

* Mention the use case of I/O running concurrent with a computational
  thread.

* Be a tad more forceful about recommending Queue over other approaches
  to synchonization.

* Eliminate discussion around having a single interpreter.  This is a
  more advanced discussion that belongs in the library reference and
  in a section on extending and embedding.
2004-08-16 05:11:04 +00:00
Raymond Hettinger 8df4e6b020 Fix punctuation typo. 2004-08-15 23:51:38 +00:00
Raymond Hettinger 2864b808c7 Add a notes section to the docs:
* Discuss representation error versus loss of significance.
* Document special values including qNaN, sNaN, +0, -0.
* Show the suprising display of non-normalized zero values.
2004-08-15 23:47:48 +00:00
Raymond Hettinger 5c8d29cb13 SF patch #872326: generator expression implementation
(Contributed by Jiwon Seo.)

Add genexps to the reference manual.
2004-08-15 23:28:10 +00:00
Skip Montanaro e5069019e7 Add get_history_item and replace_history_item functions to the readline
module.  Closes patch #675551.  My apologies to Michal Vitecek for taking so
long to process this.
2004-08-15 14:32:06 +00:00
Johannes Gijsbers b112d6ed78 bug 990669: os.path.normpath may alter the meaning of a path if it contains
symbolic links. This has been documented in a comment since 1992, but is now in
the library reference as well.
2004-08-14 14:41:32 +00:00
Tim Peters 83e259a2c2 Another microburst of snail-like progress. 2004-08-13 21:55:21 +00:00
Tim Peters 41a65ea7fe Doctest has new traceback gimmicks in 2.4. While trying to document
them (which they are now), I had to rewrite the code to understand
it.  This has got to be the most DWIM part of doctest -- but in context
is really necessary.
2004-08-13 03:55:05 +00:00
Neal Norwitz 2e56c8a260 SF #1005913, Patch to allow building of paper-*/dist.pdf by Jeff Epler
There were subsections without sections, so drop a sub.
2004-08-13 02:56:16 +00:00
Neal Norwitz ee6511b309 Fix the version number in which changes were made 2004-08-13 02:34:06 +00:00
Tim Peters 2603960525 Markup fiddling. 2004-08-13 01:49:12 +00:00
Tim Peters 8a3b69ca8f Excruciatingly slow progress on the docs. Option flags / directive names
are documented now, and ripped out a bunch of "private name" convolutions.
2004-08-12 22:31:25 +00:00
Michael W. Hudson 5e897959db This is my patch
[ 1004703 ] Make func_name writable

plus fixing a couple of nits in the documentation changes spotted by MvL
and a Misc/NEWS entry.
2004-08-12 18:12:44 +00:00
Fred Drake 568671fc0f avoid version numbers in the text where possible 2004-08-10 21:20:10 +00:00
Fred Drake ba100c98ad clarify the behavior of the .first() and .last() methods for empty
databases

this should be backported to the release23-maint branch
2004-08-10 19:22:48 +00:00
Andrew M. Kuchling f54ac7e0ee Spelling fix 2004-08-10 19:01:50 +00:00
Fred Drake d62d507b9a added missing documentation for UseForeignDTD() (new in 2.3)
someone should backport to the release23-maint branch
2004-08-10 17:18:32 +00:00
Fred Drake fb568ca52a add descriptions for many of the new error codes 2004-08-10 16:47:18 +00:00
Fred Drake 9d92d5a9ac minor changes to make this format again 2004-08-10 15:41:03 +00:00
Tim Peters c2388a2b9c Start rewriting doctest's LaTeX docs. Damn, this is slow going! 2004-08-10 01:41:28 +00:00
Andrew M. Kuchling 24884a5ccc [Patch #1005465] Markup tweaks 2004-08-09 17:36:56 +00:00
Andrew M. Kuchling 7f203b847b Add item 2004-08-09 14:48:28 +00:00
Fred Drake 151df0794d - make a module reference a hyperlink
- wrap a long line
2004-08-09 14:12:05 +00:00
Fred Drake 830d8b8b80 fix markup nit 2004-08-09 14:06:58 +00:00
Dave Cole 9dc19c2515 Ooops - for some reason I had the wrong versionadded... 2004-08-09 05:59:09 +00:00
Dave Cole 331708b226 Patch #1003700: Add socketpair function to socket module. 2004-08-09 04:51:41 +00:00
Tim Peters feec4533e2 Bug 1003935: xrange overflows
Added XXX comment about why the undocumented PyRange_New() API function
is too broken to be worth the considerable pain of repairing.

Changed range_new() to stop using PyRange_New().  This fixes a variety
of bogus errors.  Nothing in the core uses PyRange_New() now.

Documented that xrange() is intended to be simple and fast, and that
CPython restricts its arguments, and length of its result sequence, to
native C longs.

Added some tests that failed before the patch, and repaired a test that
relied on a bogus OverflowError getting raised.
2004-08-08 07:17:39 +00:00
Andrew M. Kuchling 7219cbea8d Remove MacOS 9 ref 2004-08-07 21:35:06 +00:00
Andrew M. Kuchling c16affa811 Remove MacOS 9 refs 2004-08-07 21:33:44 +00:00
Andrew M. Kuchling 67ca703aca [Patch #862531] Update version numbers. 2004-08-07 21:30:13 +00:00
Andrew M. Kuchling 2ee6a7027a [Patch #999280 ] Update kwargs in pickle docs to match implementations 2004-08-07 20:25:55 +00:00
Andrew M. Kuchling 4eb1a00cc1 [Patch #1003861 from Dima Dorfman] Fix markup in concrete.tex:
PyObject* o -> PyObject *o to be consistent with the
rest of the file
- Correct markup for Py_True
- Remove duplicate description of PyBool_Check
2004-08-07 20:19:24 +00:00
Andrew M. Kuchling 672d2ba773 Use LaTeX markup 2004-08-07 20:17:48 +00:00
Andrew M. Kuchling 17e33e4c93 [Bug #914375] Crude modulefinder docs, but the module's code is very hard to read and it's not clear which bits are public and which aren't. The module's author should really be doing this (and using docstrings in the code, too) 2004-08-07 20:13:34 +00:00
Andrew M. Kuchling 32dbddafd5 Remove various modules that have been documented 2004-08-07 19:21:59 +00:00
Andrew M. Kuchling cbd81556bb [Bug #827209] Add footnote from Alex M. about listcomps leaking their index variables 2004-08-07 19:16:32 +00:00
Andrew M. Kuchling 59a27f1d6e Various minor edits 2004-08-07 19:10:36 +00:00
Andrew M. Kuchling 4cbe95cdd1 [Bug #866222] Update docs to match the module 2004-08-07 19:06:48 +00:00
Andrew M. Kuchling fe80b63663 [Bug #991883] Document calling condition 2004-08-07 17:53:05 +00:00
Michael W. Hudson 1baa248021 Fix
[ 1000841 ] "make pdf" failure w/ 2.4 docs

in the suggested way, by uglifying a URL.
2004-08-07 17:39:35 +00:00
Andrew M. Kuchling 0188cdb115 [Bug #998066] Mention result mismatch 2004-08-07 17:28:17 +00:00
Michael W. Hudson b6d9fc38e8 Patch:
[ 1003863 ] adds an index entry for __all__ to the tutorial
2004-08-07 17:05:42 +00:00
Andrew M. Kuchling 8def876d36 [Bug #873146] Document pickletools module (haven't tested the LaTeX yet) 2004-08-07 16:53:59 +00:00
Michael W. Hudson 049e7aaa0f Point out that the setdefault defaults the value to None. Inspired by
Michael Chermside's thinking about patch #748126 (the chief upshot of
which thinking was "reject it!").
2004-08-07 16:41:34 +00:00
Andrew M. Kuchling cbbee6fed5 [Bug #984952] Include more material from PEP 307.
I haven't tried to include all the material on old-style classes using protocols 0,1.  The details are lengthy; someone who knows
more about the pickle module should decide if they're important enough
to be in the docs or not.
2004-08-07 16:24:18 +00:00
Andrew M. Kuchling 14d535c3d4 [Bug #984952] Include some material from PEP 307 2004-08-07 15:49:24 +00:00
Andrew M. Kuchling 6f937b1c30 [Bug #998307] Use open() instead of file() in docs 2004-08-07 15:11:24 +00:00
Fred Drake 9bae19e8b1 fix two typos in markup 2004-08-07 14:28:37 +00:00
Andrew M. Kuchling e30c4d4ddc Add recent items 2004-08-07 13:58:02 +00:00
Andrew M. Kuchling 38dc2a6bf7 Simplify language 2004-08-07 13:24:12 +00:00
Andrew M. Kuchling ac6428756a Add string concat item 2004-08-07 13:13:31 +00:00
Andrew M. Kuchling ba59be04fa Bump version 2004-08-06 18:55:48 +00:00
Andrew M. Kuchling 34ed2b020a Typo fix; use 'in-place' instead of 'inplace' 2004-08-06 18:55:09 +00:00
Raymond Hettinger 52a21b8e65 SF patch #980695: efficient string concatenation
(Original patch by Armin Rigo).
2004-08-06 18:43:09 +00:00
Fred Drake 3f5c654deb fix markup nit, typo 2004-08-06 03:34:20 +00:00
Fred Drake 6bd8e842e4 update to reflect the new significance of the "@" character 2004-08-05 21:11:27 +00:00
Phillip J. Eby 1884dda233 Warn that settrace() is implementation rather than language
definition, per Guido's request  in off-list email.
2004-08-05 12:13:46 +00:00
Matthias Klose 4c8fa42aca Doc/lib/libfuncs.tex: correct items in itemize
Doc/dist/dist.tex: avoid uncommenting the verbose environment (by the py2texi tool)
2004-08-04 23:18:49 +00:00
Vinay Sajip 1cf56d0b8a Updated Logger.log() documentation to clarify that lvl parameter should be an integer. 2004-08-04 08:36:44 +00:00
Hye-Shik Chang e9ddfbb412 SF #989185: Drop unicode.iswide() and unicode.width() and add
unicodedata.east_asian_width().  You can still implement your own
simple width() function using it like this:
    def width(u):
        w = 0
        for c in unicodedata.normalize('NFC', u):
            cwidth = unicodedata.east_asian_width(c)
            if cwidth in ('W', 'F'): w += 2
            else: w += 1
        return w
2004-08-04 07:38:35 +00:00
Fred Drake f901abdd62 allow ctime(), gmtime(), and localtime() to take None as equivalent to an omitted arg
(closes SF bug #658254, patch #663482)
2004-08-03 17:58:55 +00:00
Fred Drake d04573fef0 This allows additional commands to be provided for existing setup.py
scripts without modifying either the distutils installation or the
setup.py scripts of packages with which the new commands will be used.

Specifically, an option is added to distutils that allows additional
packages to be searched for command implementations in addition to
distutils.command.  The additional packages can be specified on the
command line or via the installation or personal configuration files
already loaded by distutils.

For discussion, see the thread starting with:

http://mail.python.org/pipermail/distutils-sig/2004-August/004112.html

This closes SF patch #102241.
2004-08-03 16:37:40 +00:00
Fred Drake 2be406bd9f let's avoid the extra nesting where reasonable 2004-08-03 16:02:35 +00:00
Martin v. Löwis 9513e34ac4 Patch #823072: add option to NOT use ~/.netrc in nntplib.NNTP(). 2004-08-03 14:36:32 +00:00
Raymond Hettinger 70fcdb8be0 Document general mappings for the locals argument for exec and execfile(). 2004-08-03 05:17:58 +00:00
Fred Drake bec69f6a2e fix a little lie ;-( 2004-08-02 23:05:25 +00:00
Neal Norwitz 7fdd92f31f Fix typo though 2004-08-02 21:56:33 +00:00
Fred Drake e72bd4d621 fix markup error 2004-08-02 21:50:26 +00:00
Fred Drake 0c84c7f915 start filling in documentation on extending distutils 2004-08-02 21:39:11 +00:00
Andrew M. Kuchling 77a602fbf2 Add PEP318 2004-08-02 13:48:18 +00:00
Andrew M. Kuchling d91fcbe265 Add import change; add empty section for function decorators 2004-08-02 12:44:28 +00:00
Andrew M. Kuchling 1455f795e2 Update item 2004-08-02 12:09:58 +00:00
Raymond Hettinger 829d6c4138 Fix doubled word. 2004-08-02 08:36:07 +00:00
Anthony Baxter c2a5a63654 PEP-0318, @decorator-style. In Guido's words:
"@ seems the syntax that everybody can hate equally"
Implementation by Mark Russell, from SF #979728.
2004-08-02 06:10:11 +00:00
Tim Peters fd7dc5169c Typo repair. 2004-08-02 04:30:37 +00:00
Tim Peters 0c6199e8ed Completed a sentence I left dangling. 2004-08-02 04:14:10 +00:00
Tim Peters cfd575d398 PyImport_ImportModule, PyImport_ImportModuleEx, PyImport_ExecCodeModule:
in failure cases, incompletely initalized module objects are no longer
left behind in sys.modules.
2004-08-02 03:46:45 +00:00
Neal Norwitz 750f060ad7 SF bug #1001088, incorrect reference to macro named foo
Backport candidate.
2004-08-01 22:36:40 +00:00
Fred Drake 63a5d0b1cf re-wrap paragraphs containing long lines 2004-07-30 19:12:38 +00:00
Fred Drake 69013d070e - document the termination condition for cmd.Cmd.cmdloop()
- document the use of the return value for cmd.Cmd.do_*() methods
2004-07-30 18:58:54 +00:00
Martin v. Löwis 479b7a7cdb Fix typo. 2004-07-30 16:09:19 +00:00
Martin v. Löwis 8ddb638e43 Add closing methoddesc. Add versionadded. Rewrap. 2004-07-30 16:08:49 +00:00
Raymond Hettinger f9fd0d7988 SF bug #997533: "disjunct" should be "disjoint"
* Use plain wording in docs for id().
* Use normal quotation marks instead of single quotes in the description.
2004-07-29 06:06:34 +00:00
Neal Norwitz f9f0b21653 SF #998170, fix typo. Backport candidate 2004-07-29 03:48:59 +00:00
Skip Montanaro 6d3db7000e Add missing doc for Py_True/Py_False. Use the correct macro to define
Py_RETURN_FALSE and Py_RETURN_TRUE.
2004-07-29 02:16:04 +00:00
Andrew M. Kuchling 671c506737 Add new encodings 2004-07-28 15:29:39 +00:00
Skip Montanaro 33ee76ae9e A little boolean music if you please, maestro... (Not sure I have the
versionadded{} args quite right).
2004-07-28 14:17:04 +00:00
Neal Norwitz bee417439e Add versionadded info 2004-07-28 02:34:12 +00:00
Andrew M. Kuchling ce4bae6170 Add an item 2004-07-27 12:13:25 +00:00
Martin v. Löwis 7b9190b8fc Patch #998149: imaplib deleteacl and myrights. 2004-07-27 05:07:19 +00:00
Andrew M. Kuchling 5785a1391e Add some items 2004-07-26 19:28:46 +00:00
Andrew M. Kuchling e03664ff22 Two typo fixes 2004-07-26 19:25:54 +00:00
Andrew M. Kuchling e3e1ecacd5 [Bug #997166] Fix example 2004-07-26 18:52:48 +00:00
Fred Drake fdccf1ad6e fix information about what flag database files are opened with by default 2004-07-26 16:33:29 +00:00
Martin v. Löwis cc0f93233a Patch #605370: Add description[s] for RFC 2980 compliance. 2004-07-26 12:40:50 +00:00
Martin v. Löwis 37ead8f1c3 Patch #997668: Correct explanation of salts.
Will backport to 2.3.
2004-07-26 12:05:16 +00:00
Tim Peters abba5c067d Explain that most floats are actually integers. This is a common confusion
for people using floor(), ceil() and modf().
2004-07-26 05:12:01 +00:00
Tim Peters 9a729a1cc5 Typo in new docs. 2004-07-26 04:58:50 +00:00
Tim Peters d6ef19309d SF bugs 996748: os.environ documentation should indicate unreliability
Clarifed that os.environ is captured once; emphasized that it's better
to assign to os.environ than to call putenv() directly (the putenv()
docs said so, but the environ docs didn't).
2004-07-26 00:42:41 +00:00
Tim Peters 66bb6e661c SF bug 996392: math and cmath docs don't specify radians
Major rewrite of the math module docs.  Slapped in "radians" where
appropriate; grouped the functions into reasonable categories; supplied
many more words to address common confusions about some of the subtler
issues.
2004-07-24 23:00:24 +00:00
Thomas Heller fe0808382b Fix an uncorrect function prototype.
Will backport to release23-maint.

BTW: Shouldn't it read PY_LONG_LONG instead of 'long long' ?
2004-07-23 14:49:52 +00:00
Tim Peters 336689b9cc A few trivial edits. 2004-07-23 02:48:24 +00:00
Raymond Hettinger cab5b94592 SF bug #995983 and #995987: Documentation nits. 2004-07-22 19:33:53 +00:00
Gustavo Niemeyer 7bd33c5e22 This change implements the following gettext features, as
discussed recently in python-dev:

In _locale module:

- bind_textdomain_codeset() binding

In gettext module:

- bind_textdomain_codeset() function
- lgettext(), lngettext(), ldgettext(), ldngettext(),
  which return translated strings encoded in
  preferred system encoding, if
  bind_textdomain_codeset() was not used.
- Added equivalent functionality in translate()
  function and catalog classes.

Every change was also documented.
2004-07-22 18:44:01 +00:00
Andrew M. Kuchling c12527e2c7 [Bug #990524] Fix typo 2004-07-21 21:34:45 +00:00
Fred Drake 4ab0e9e541 revise wording to avoid confusion for non-native English speakers
(second occurance of the same wording)
2004-07-21 17:36:47 +00:00
Fred Drake 20938f57ba revise wording to avoid confusion for non-native English speakers 2004-07-21 17:18:19 +00:00
Vinay Sajip b4bf62f807 Added an extra example to the basic example section 2004-07-21 14:40:11 +00:00
Andrew M. Kuchling 0ad20f18fe Update Decimal section to match the current module 2004-07-21 13:00:06 +00:00
Andrew M. Kuchling 65a333219f Add PEP 331; add constancy of None; minor edits 2004-07-21 12:41:38 +00:00
Skip Montanaro bf76075a4b fix typo, highlight True/False correctly 2004-07-21 02:47:10 +00:00
Neal Norwitz 7728b4719e SF #994605, fcntl example is broken
The last call to fcntl (which wasn't changed) doesn't work for me, but
the first part works now.

Backport candidate.
2004-07-21 01:41:14 +00:00
Neal Norwitz d96d1015ef SF #918101, allow files >= 8 GB using GNU extension 2004-07-20 22:23:02 +00:00
Martin v. Löwis b0c319a905 Patch #993187: Make rstrip doc similar to lstrip.
Backported to 2.3.
2004-07-19 16:34:01 +00:00
Neal Norwitz 76aa2eff4e Get doc to build (add missing backslash) 2004-07-19 01:39:54 +00:00
Tim Peters 3d7d372ce3 Whitespace normalization, via reindent.py. 2004-07-18 06:25:50 +00:00
Hye-Shik Chang 2bb146f2f4 Bring CJKCodecs 1.1 into trunk. This completely reorganizes source
and installed layouts to make maintenance simple and easy.  And it
also adds four new codecs; big5hkscs, euc-jis-2004, shift-jis-2004
and iso2022-jp-2004.
2004-07-18 03:06:29 +00:00
Hye-Shik Chang 910d8f1e89 Change CJK encoding aliases to their most popular variation of
hyphen and underscores in consistency of non-CJK aliases.
(Spotted by Mike Brown at SF #969415)
2004-07-17 14:44:43 +00:00
Andrew M. Kuchling e970d2a310 Add a definition (found in the Debian patches for 2.3.4) 2004-07-17 14:43:32 +00:00
Hye-Shik Chang 2b05248e8b SF #990497: Fix a trivial typo in sorted() example.
(Submitted by Daniel Pezely)
2004-07-17 13:53:48 +00:00
Andrew M. Kuchling 872dc5c457 Minor edits 2004-07-17 13:35:43 +00:00
Tim Peters 8ff9f9f4aa Supply missing word in new datetime docs, aggravated by copy-paste-edit. 2004-07-17 01:42:26 +00:00
Jack Jansen 6c09a21f66 Fix for #795649: explain how to use TextEdit for editing Python code. 2004-07-15 22:38:06 +00:00
Andrew M. Kuchling 0045717090 Add thread-local feature 2004-07-15 11:52:40 +00:00
Andrew M. Kuchling 23406894ea Correct a paragraph: basicConfig() isn't actually new 2004-07-15 11:44:42 +00:00
Tim Peters de8332171a SF bug 990749: os constants missing
A LaTeX comment identified the 6 os.O_XXX constants the docs claimed
are available on Windows but aren't.  The bug report listed the same 6.
Split these non-Windows constants into a different table with a possibly
correct "Availability:" claim.
2004-07-15 05:46:37 +00:00
Tim Peters 5960d80e11 s/it's/its/, s/NULL/NULL{}/, where appropriate. 2004-07-15 04:23:13 +00:00
Tim Peters eda29306b3 Formalize that the Py_VISIT macro requires that the tp_traverse
implementation it's used in must give its arguments specific names.
2004-07-15 04:05:59 +00:00
Andrew M. Kuchling 89ba1fff17 Bump version; update date 2004-07-14 21:56:19 +00:00
Raymond Hettinger 9296023938 Improve examples for working with the context API. 2004-07-14 21:06:55 +00:00
Jim Fulton d15dc06df0 Implemented thread-local data as proposed on python-dev:
http://mail.python.org/pipermail/python-dev/2004-June/045785.html
2004-07-14 19:11:50 +00:00
Jim Fulton aa6389e13b Documented the new Py_VISIT macro to simplify implementation of
tp_traverse handlers. (Tim made me do it. ;)
2004-07-14 19:08:17 +00:00
Jim Fulton 8c5aeaa277 Implemented a new Py_CLEAR macro. This macro should be used when
decrementing the refcount of variables that might be accessed as a
result of calling Python
2004-07-14 19:07:35 +00:00
Jim Fulton 7a0e8bc283 Updated documentation to:
- point out the importance of reassigning data members before
  assigning thier values

- correct my missconception about return values from visitprocs. Sigh.

- mention the labor saving Py_VISIT and Py_CLEAR macros.
2004-07-14 19:07:24 +00:00
Guido van Rossum 8cec3ab0e4 - Bug #981530: Fix UnboundLocalError in shutil.rmtree(). This affects
the documented behavior: the function passed to the onerror()
  handler can now also be os.listdir.

[I could've sworn I checked this in, but apparently I didn't, or it
got lost???]
2004-07-14 00:48:58 +00:00
Fred Drake c0ed9c4956 clarify where \versionadded and \versionchanged should be placed when
they are used
2004-07-13 21:04:26 +00:00
Tim Peters e45d5a3b00 Claifications: visit procs are supplied by the core, users aren't
expected to write their own.  A NULL "object" must not be passed to
the visit callback.  A non-zero return from a visit proc isn't
necessarily an error return (and it doesn't matter to the tp_traverse
code *what* it might signify, their only job is to return it).
2004-07-13 17:18:10 +00:00
Fred Drake 0751d554c0 generalize a bit; no need to mention my user id directly 2004-07-13 17:08:10 +00:00
Andrew M. Kuchling 2a510ce119 Wordsmithing 2004-07-13 14:03:31 +00:00
Brett Cannon 71868e74d6 Add another point in the "Restrictions" section about how the handling of FTP
URLs will seemingly succeed to read a URL that points to a file whose
permissions you do not have to read.

Backport candidate once everyone agrees with the wording.
2004-07-13 00:48:42 +00:00
Vinay Sajip 20f42c433b Fixed minor bugs in the example configuration file 2004-07-12 15:48:04 +00:00
Raymond Hettinger d7c7115926 Small elaboration and typo fixes. 2004-07-12 13:22:14 +00:00
Raymond Hettinger ca1a775ab9 Fix markup. 2004-07-12 13:00:45 +00:00
Anthony Baxter 1869df1154 another note for amk 2004-07-12 08:15:37 +00:00
Tim Peters 5af0e41482 Bug #788520: Queue class has logic error when non-blocking
I don't agree it had a bug (see the report), so this is *not* a candidate
for backporting, but the docs were confusing and the Queue implementation
was old enough to vote.

Rewrote put/put_nowait/get/get_nowait from scratch, to use a pair of
Conditions (not_full and not_empty), sharing a common mutex.  The code
is 1/4 the size now, and 6.25x easier to understand.  For blocking
with timeout, we also get to reuse (indirectly) the tedious timeout
code from threading.Condition.  The Full and Empty exceptions raised
by non-blocking calls are now easy (instead of nearly impossible) to
explain truthfully:  Full is raised if and only if the Queue truly
is full when the non-blocking put call checks the queue size, and
similarly for Empty versus non-blocking get.

What I don't know is whether the new implementation is slower (or
faster) than the old one.  I don't really care.  Anyone who cares
a lot is encouraged to check that.
2004-07-12 00:45:14 +00:00
Tim Peters 183dabcd73 SF patch 986010: add missing doc for datetime C API, from
Anthony Tuininga.

This is a derived patch, taking the opportunity to add some organization
to the now-large pile of datetime-related macros, and to factor out
tedious repeated text.

Also improved some clumsy wording in NEWS.
2004-07-11 19:26:19 +00:00
Kurt B. Kaiser e246508779 Add FAQ on non-GNU make error. Update copyright date to 2004. 2004-07-11 16:40:31 +00:00
Fred Drake 2363e8fece Added documentation for the "smtpd" module.
Closes SF bug #450803.
2004-07-11 16:25:25 +00:00
Raymond Hettinger 88e8e34ab0 Style nit. 2004-07-11 13:20:11 +00:00
Raymond Hettinger 44dc13bf3e Fix decimal write-up nits. 2004-07-11 12:49:47 +00:00
Raymond Hettinger 65df07bf23 Minor improvements, fixups and wording changes everywhere. 2004-07-11 12:40:19 +00:00
Kurt B. Kaiser ad5206fc02 Clarify requirement for GNU make 2004-07-11 04:10:14 +00:00
Kurt B. Kaiser 8932b41669 Patch 851752 (fixes bug 820583)
Patch by John J Lee
Reviewed by Jeff Epler / KBK
Doc built OK.

urlopen() may return None if no handler handles the request.

Also clarify what install_opener does.

M liburllib2.tex
2004-07-11 02:13:17 +00:00
Brett Cannon cd77dd6321 Fix minor error in example. 2004-07-10 23:06:07 +00:00
Brett Cannon 711e7d97e4 Add PyArg_VaParseTupleAndKeywords(). Document this function and
PyArg_VaParse().

Closes patch #550732.  Thanks Greg Chapman.
2004-07-10 22:20:32 +00:00
Brett Cannon 91cc5cd188 Clarify docs for inspect.getargspec() that the fourth value is None when there
are no default arguments for the function.
2004-07-10 21:13:06 +00:00
Andrew M. Kuchling 3a2418a1d6 [Patch #969900] Various corrections and updates to cookielib docs 2004-07-10 18:41:28 +00:00
Andrew M. Kuchling 300ce19592 [Patch #972310] Apply correction to docs 2004-07-10 18:28:33 +00:00
Raymond Hettinger 21f9fce968 Fix typo. 2004-07-10 16:11:03 +00:00
Andrew M. Kuchling 099bd524a4 [Bug 949832] Fix example; edit sentence 2004-07-10 16:01:10 +00:00
Raymond Hettinger bf4406971c Improve Context construction and representation:
* Rename "trap_enablers" to just "traps".
* Simplify names of "settraps" and "setflags" to just "traps" and "flags".
* Show "capitals" in the context representation
* Simplify the Context constructor to match its repr form so that only
  the set flags and traps need to be listed.
* Representation can now be run through eval().

Improve the error message when the Decimal constructor is given a float.

The test suite no longer needs a duplicate reset_flags method.
2004-07-10 14:14:37 +00:00
Andrew M. Kuchling d9dfe0213f Remove a few elderly sentences 2004-07-10 13:48:54 +00:00
Andrew M. Kuchling ff8113f8d0 Replace example with simpler alternative using PyGILState_{Ensure,Require). Can someone please confirm this change is OK? 2004-07-10 13:42:52 +00:00
Andrew M. Kuchling 371d98ab15 [Bug #987835] Add documentation from PEP 311. (Untested TeX code.) 2004-07-10 13:31:18 +00:00
Raymond Hettinger 0d278b861e SF bug #987486: fix typo. 2004-07-10 11:15:56 +00:00
Raymond Hettinger 682be2249d SF bug 988387: markup nits. 2004-07-10 11:11:15 +00:00
Anthony Baxter 5da4c83a6b reminder for amk 2004-07-09 16:16:46 +00:00
Raymond Hettinger 5aa478badf Module and tests:
* Map conditions to related signals.
* Make contexts unhashable.
* Eliminate used "default" attribute in exception definitions.
* Eliminate the _filterfunc in favor of a straight list.

Docs:
* Eliminate documented references to conditions that are not signals.
* Eliminate parenthetical notes such as "1/0 --> Inf" which are no
  longer true with the new defaults.
2004-07-09 10:02:53 +00:00
Raymond Hettinger 97c9208c6c Incorporate Facundo's suggestions. 2004-07-09 06:13:12 +00:00
Raymond Hettinger 9499658b61 Add a link to the decimal module docs. 2004-07-09 06:00:32 +00:00
Skip Montanaro 2b2795ac6d show how easy it is to manipulate individual columns - from a request on
c.l.py
2004-07-08 19:49:10 +00:00
Raymond Hettinger 081483cd42 Fix markup and nits. 2004-07-08 09:33:00 +00:00
Raymond Hettinger 536f76b25a Fix markup, typos, and nits. 2004-07-08 09:22:33 +00:00
Fred Drake 63a0191c8a Deal with macros that have to be replaced with simple text; only a
couple of these are currently found in index data, but these should
all be handled in the same way.

Closes SF bug #952737.
2004-07-08 03:56:12 +00:00
Vinay Sajip e3c330b42a Replaced some tabs with spaces in verbatim section. 2004-07-07 15:59:49 +00:00
Andrew M. Kuchling ee5e4cd899 [Bug #984017] Incorrect prototype, fixed by Timothy Stranex 2004-07-07 13:07:47 +00:00
Andrew M. Kuchling bcefe698b0 Add logging changes 2004-07-07 13:01:53 +00:00
Tim Peters 74979664d0 Typo repair. 2004-07-07 02:32:36 +00:00
Raymond Hettinger 2f55eb4cca Demonstrate how to round final result. 2004-07-06 01:55:14 +00:00
Raymond Hettinger 10959b1c2a Expand examples to show polymorphism 2004-07-05 21:13:28 +00:00
Raymond Hettinger 77e13b4ead Simplify examples. 2004-07-05 20:27:53 +00:00
Raymond Hettinger c4f93d4410 Doc tested the recipes. 2004-07-05 20:17:13 +00:00
Raymond Hettinger 9c719bafbf Fix typo 2004-07-05 18:56:03 +00:00
Raymond Hettinger d84efb3d93 * Added missing info on construction from a tuple.
* Added a recipe section.
2004-07-05 18:41:42 +00:00
Raymond Hettinger 8de63a206e Add decimal docs to the core. 2004-07-05 05:52:03 +00:00
Andrew M. Kuchling 71432f1db6 Various edits 2004-07-05 01:40:07 +00:00
Andrew M. Kuchling 3bf85f1ae8 Various edits 2004-07-05 01:37:07 +00:00
Andrew M. Kuchling 3b7909160e Bump version #; write introductory para 2004-07-04 16:39:40 +00:00
Andrew M. Kuchling d0b6d9d892 More additions 2004-07-04 15:35:00 +00:00
Nicholas Bastin 068979cdd6 Textual change to make the doc reflect reality 2004-07-04 04:47:40 +00:00
Andrew M. Kuchling d4be86cb09 Write another section 2004-07-04 01:44:04 +00:00
Andrew M. Kuchling c8f8a814e2 Rewrite two sections 2004-07-04 01:26:42 +00:00
Vinay Sajip a13c60b810 Moved example section up to just after the section on Logger objects, and changed it to use the new basicConfig() API 2004-07-03 11:45:53 +00:00
Fred Drake 0a4dd390bf Make weak references subclassable:
- weakref.ref and weakref.ReferenceType will become aliases for each
  other

- weakref.ref will be a modern, new-style class with proper __new__
  and __init__ methods

- weakref.WeakValueDictionary will have a lighter memory footprint,
  using a new weakref.ref subclass to associate the key with the
  value, allowing us to have only a single object of overhead for each
  dictionary entry (currently, there are 3 objects of overhead per
  entry: a weakref to the value, a weakref to the dictionary, and a
  function object used as a weakref callback; the weakref to the
  dictionary could be avoided without this change)

- a new macro, PyWeakref_CheckRefExact(), will be added

- PyWeakref_CheckRef() will check for subclasses of weakref.ref

This closes SF patch #983019.
2004-07-02 18:57:45 +00:00
Raymond Hettinger 214b1c3aae SF Bug #215126: Over restricted type checking on eval() function
The builtin eval() function now accepts any mapping for the locals argument.
Time sensitive steps guarded by PyDict_CheckExact() to keep from slowing
down the normal case.  My timings so no measurable impact.
2004-07-02 06:41:07 +00:00
Skip Montanaro 78bace7442 add cp866 row 2004-07-02 02:14:34 +00:00
Brett Cannon d88471f432 Change signatures for arguments to "s" and friends to be the proper ``const
char *`` instead of just ``char *``.  Also added the mentioning of "const" in
some places where it was left out even when the signature already stated the
fact.

Closes bug #980925.
2004-07-01 20:55:42 +00:00
Walter Dörwald ac1075a645 Document that encode() and decode() raise UnicodeError
instead of ValueError.

Add a note about error handling schemes added by PEP 293.
2004-07-01 19:58:47 +00:00
Skip Montanaro ecf7a52bb8 link to the codecs page from the "".encode() description. 2004-07-01 19:26:04 +00:00
Fred Drake 1b89656d70 add omitted markup 2004-07-01 14:26:31 +00:00
Raymond Hettinger 68a37ac841 * Fix typos.
* Format an example so that the identation is more obvious.
* Add a section on the decimal module to the Brief Tour Part II.
2004-07-01 12:56:54 +00:00
Raymond Hettinger 0fff62f9cd Move Decimal from the sandbox into production. 2004-07-01 11:52:15 +00:00
Skip Montanaro 2ccf5d689b use file() in preference to open() 2004-06-30 21:06:45 +00:00
Michael W. Hudson d5cf143482 Check in the updated version of patch #957240, which doesn't rely
on the marshalling characteristics of infinities.
2004-06-30 09:02:33 +00:00
Fred Drake 96b935e643 fix handling when a proper getopt(1) is available; the "--"
end-of-options marker wasn't recognized
2004-06-29 14:39:06 +00:00
Andrew M. Kuchling 6d3a0d2dff [Bug #948970] Add PyExc_* symbols to index.
(I ran this through texcheck, but don't have LaTeX installed on this machine and therefore haven't
verified that the changes are accepted by LaTeX.)
2004-06-29 13:52:14 +00:00
Andrew M. Kuchling 7dd8fda49f [Bug #978556] Update SHA spec URL; bugfix candidate 2004-06-29 13:35:01 +00:00
Brett Cannon a031a0870d Add a missing space. 2004-06-29 04:14:02 +00:00
Brett Cannon 289e4cba1c Changed applicable use of ``char *`` declarations that are passed into
PyArg_ParseTuple() to ``const char *`` to match the recommendation made in
section 1.3 and to support better coding habits.

Section 1.8 ("Keyword Parameters for Extension Functions") and it's coding
example were not touched since it is stems from an accredited source and thus
did not want to step on anyone's toes.
2004-06-29 03:48:23 +00:00
Barry Warsaw 11b91a0ea3 Added socket.getservbyport(), and make its second argument and that of
getservbyname() optional.  Update the tests and the docs.
2004-06-28 00:50:43 +00:00
Martin v. Löwis ef82d2fdfe Patch #923098: Share interned strings in marshal. 2004-06-27 16:51:46 +00:00
Brett Cannon 634893d1a3 Mention Py_RETURN_NONE when introducing the idiom of how to have a function
return Py_None.
2004-06-27 04:28:00 +00:00
Brett Cannon 555a96475d Clarify sentence at end of Intermezzo section stating that PyMODINIT_FUNC will
be discussed later by saying it is the function return type of the sample code
to make spotting it easier.
2004-06-26 23:10:32 +00:00
Fred Drake ec6229e352 Make distutils "install --home" support all platforms. 2004-06-25 23:02:59 +00:00
Fred Drake b86aa99eb9 move the note about the bsddb185 module above the "See also" box; that
should always go last in the relevant section's main content, but
before child sections
2004-06-24 06:03:59 +00:00
Tim Peters 9ddf40b4e1 SF patch 876130: add C API to datetime module, from Anthony Tuininga.
The LaTeX is untested (well, so is the new API, for that matter).
Note that I also changed NULL to get spelled consistently in concrete.tex.
If that was a wrong thing to do, Fred should yell at me.
2004-06-20 22:41:32 +00:00
Raymond Hettinger 28224f897a Improve the documented advice on how to best use heapq.heapreplace(). 2004-06-20 09:07:53 +00:00
Thomas Heller dd6d207cf8 Fix an obvious typo (It *is* a typo, or not?) 2004-06-18 17:31:23 +00:00
Thomas Heller a42bc21ef8 The 'distributing python modules' manual now has an index. 2004-06-18 08:27:36 +00:00
Thomas Heller 949f66141b Fix typo - the module is named distutils.util. 2004-06-18 06:55:28 +00:00
Fred Drake 964c798a94 Use getopt where possible, so this supports option letters that get
jammed together on thos platforms.
2004-06-17 22:04:17 +00:00
Brett Cannon 3706855d11 Add apparently missing word for InvalidStateError definition.
Closes bug #973901.  Thanks Brian Gough.
2004-06-17 21:34:05 +00:00
Fred Drake 9e1ac2496f - add link to the downloadable package in the generated email
- misc. changes
2004-06-17 18:36:54 +00:00
Fred Drake 0083c920f2 make the tarball available for download instead of throwing it away 2004-06-17 17:19:12 +00:00
Michael W. Hudson 9e151d149e add missing closing quote. 2004-06-17 13:29:11 +00:00
Martin v. Löwis 64af6c545c Comment that getfilesystemencoding returns mbcs even on NT+. Fixes #964870. 2004-06-16 04:53:46 +00:00
Raymond Hettinger aefde435ef Reverse argument order for nsmallest() and nlargest().
Reads better when the iterable is a generator expression.
2004-06-15 23:53:35 +00:00
Fred Drake 40333ceeac add a pointer to the Distutils Cookbook 2004-06-14 22:07:50 +00:00
Raymond Hettinger b67ad7e671 Patch #826074: cmath.log optional base argument, fixes #823209
(Contributed by Andrew Gaul.)
2004-06-14 07:40:10 +00:00
Martin v. Löwis ad21945d03 Back out #957240. 2004-06-14 04:58:42 +00:00
Neal Norwitz 965eeca630 SF bug #970042, lockf() signature uses len, doc refers to length (use length, same as docstring) 2004-06-13 21:11:03 +00:00
Raymond Hettinger 2e3dfaf707 Install C version of heapq.nsmallest(). 2004-06-13 05:26:33 +00:00
Raymond Hettinger 2e6694086f Minor wording and spacing nits. 2004-06-12 07:59:40 +00:00
Raymond Hettinger 34809170e5 Complete the list of weakreferencable objects. 2004-06-12 06:56:44 +00:00
Fred Drake 0eb32a65b0 Add support for package data.
This is basically the support for package data from Phillip Eby's
setuptools package.  I've changed it only to fit it into the core
implementation rather than to live in subclasses, and added
documentation.
2004-06-11 21:50:33 +00:00
Raymond Hettinger 33ecffb65a SF patch #969791: Add nlargest() and nsmallest() to heapq. 2004-06-10 05:03:17 +00:00
Thomas Heller 7d019664d7 Defining Py_GCC_ATTRIBUTE finds even some more undocumented functions. 2004-06-09 18:50:54 +00:00
Thomas Heller 4369b59b6d Public Python functions are nowadays marked PyAPI_FUNC, not DL_IMPORT. 2004-06-09 18:38:20 +00:00
Fred Drake da4513a88b make a reference to the SimpleHTTPServer module a hyperlink to the
docs
2004-06-09 14:50:19 +00:00
Martin v. Löwis 737ea82a5a Patch #774665: Make Python LC_NUMERIC agnostic. 2004-06-08 18:52:54 +00:00
Fred Drake 7f35404b7b - markup fix
- explain Python/ceval.c from what; lots of people don't use a source
  distro any more
2004-06-08 14:01:27 +00:00
Martin v. Löwis bdec50f027 Feature request #935915: Add os.path.devnull. 2004-06-08 08:29:33 +00:00
Martin v. Löwis f30d60edbc Patch #510695: Add TSC profiling for the VM. 2004-06-08 08:17:44 +00:00
Neil Schemenauer d68d3ee3dd Note that memory returned by PyBuffer_New is not specifically aligned.
Closes SF bug #472568.
2004-06-08 02:58:50 +00:00
Raymond Hettinger d348193ff2 Add genexps to the glossary. 2004-06-07 21:52:47 +00:00
Andrew M. Kuchling 44cbfd7819 [Bug #953177] Mention .getlist(); text from Paul Moore 2004-06-06 23:28:23 +00:00
Tim Peters 0b4d1ee29d SF 964876 mapping a 0 length file
Document that it can't be done on Windows.
2004-06-06 16:51:46 +00:00
Phillip J. Eby de48307f76 Added documentation to address SF bug #963246: limitations on multiple
inheritance in Python when a C type is one of the bases.
2004-06-06 15:59:18 +00:00
Nicholas Bastin cfa157d808 Doc fix for SF #962633. 2004-06-06 01:17:52 +00:00
Andrew M. Kuchling e1ca355425 [Bug #918710] Add paragraph to clarify docs 2004-06-05 19:25:30 +00:00
Andrew M. Kuchling 1b50b43bee [Bug #936837] Add missing word 2004-06-05 19:00:55 +00:00
Hye-Shik Chang 2d6783b4bc SF #966375: Fix typo (Reported by Kristian Ovaska) 2004-06-04 09:33:18 +00:00
Fred Drake 22ec5c3639 if we must argue over the/they, we can just remove the unecessary word 2004-06-03 17:19:25 +00:00
Fred Drake 175d18840a avoid backticks in examples; use repr() instead 2004-06-03 16:23:23 +00:00
Raymond Hettinger 2d1a2aa117 Fix typo: the-->they 2004-06-03 14:13:04 +00:00
Guido van Rossum 6dfed6c41f Fix typo. 2004-06-03 13:56:05 +00:00
Michael W. Hudson 3151e18505 Small clarification. 2004-06-03 13:36:42 +00:00
Fred Drake d6d35d954b - fix typo reported by John Belmonte
- wrap a long line
2004-06-03 13:31:22 +00:00
Martin v. Löwis 77ca6c4c84 Warn abou missing mutate flag to ioctl. Fixes #696535. 2004-06-03 12:47:26 +00:00
Martin v. Löwis 9bc4f2def3 Drop claims that Unicode always means UCS-2. Fixes #881861. 2004-06-03 09:55:28 +00:00
Martin v. Löwis 4a9b8069e0 Document string methods that are locale-dependent. Fixes #935749.
Will backport to 2.3.
2004-06-03 09:47:01 +00:00
Martin v. Löwis eac324b90b Patch #957240: Add count parameter to asyncore.loop. 2004-06-03 09:18:35 +00:00
Hye-Shik Chang 974ed7cfa5 - SF #962502: Add two more methods for unicode type; width() and
iswide() for east asian width manipulation. (Inspired by David
Goodger, Reviewed by Martin v. Loewis)
- Move _PyUnicode_TypeRecord.flags to the end of the struct so that
no padding is added for UCS-4 builds. (Suggested by Martin v. Loewis)
2004-06-02 16:49:17 +00:00
Andrew M. Kuchling d783694dea Remove old reminder 2004-06-02 15:33:59 +00:00
Martin v. Löwis 9c322fbe36 The expression list in inheritance is not optional. Fixes #960448.
Will backport to 2.3.
2004-06-02 12:59:59 +00:00
Martin v. Löwis 477c85631a Move grammar rule for lambda_form into section on lambdas. Fixes #964525. 2004-06-02 12:54:33 +00:00
Martin v. Löwis 13ff116ac7 Fix typo reported in #964592. Will backport to 2.3. 2004-06-02 12:48:20 +00:00
Martin v. Löwis dd07e59eee Document PyModule_AddIntConstant to take a long. Fixes #962471.
Will backport to 2.3.
2004-06-02 12:45:27 +00:00
Martin v. Löwis e440e47e91 Patch #957398: Add public API for Generator Object/Type. 2004-06-01 15:22:42 +00:00
Raymond Hettinger e148595504 Fixup spacing in an example. 2004-05-31 22:53:25 +00:00
Tim Peters 2f50e90818 SF patch 959726: sdist versus SVN
The disutils sdist command now ignores .svn directories.
2004-05-31 19:27:59 +00:00
Martin v. Löwis 92816de18e Patch #932930: suggest the use of rawstrings for backslashes. 2004-05-31 19:01:00 +00:00
Martin v. Löwis 2a6ba9097e Patch #963318: Add support for client-side cookie management. 2004-05-31 18:22:40 +00:00
Raymond Hettinger 874ebd5c3d Add weakref support to sockets and re pattern objects. 2004-05-31 03:15:02 +00:00
Raymond Hettinger 027bb633b6 Add weakref support to sockets and re pattern objects. 2004-05-31 03:09:25 +00:00
Raymond Hettinger 4ccf336e56 Fill-in the introductory paragraph for the library tour. 2004-05-26 13:57:54 +00:00
Raymond Hettinger 846865bba6 Add a further tour of the standard library. 2004-05-26 13:52:59 +00:00
Raymond Hettinger a8aebcedf9 Follow official recommendation for domain names in examples. 2004-05-25 16:08:28 +00:00
Skip Montanaro 79cddc56b3 stupid, stupid, stupid... raw_input() already supports readline() if the
readline module is loaded.
2004-05-24 14:20:16 +00:00
Skip Montanaro b98a8ba14d Add example that uses readline.readline(). 2004-05-23 19:06:41 +00:00
Skip Montanaro 0dc23101a0 Exposed readline() function from the readline module. 2004-05-23 17:46:50 +00:00
Raymond Hettinger e36894da3a Updated to reflect new types. 2004-05-22 16:38:11 +00:00
Raymond Hettinger 956e4f792f Clarify when iter() is first called in generator expressions. 2004-05-20 22:59:26 +00:00
Piers Lauder 8bc81fc5c7 Added description for authenticate and namespace 2004-05-20 12:12:58 +00:00
Raymond Hettinger 6e1fd2f208 Improved wording for generator expressions. 2004-05-19 22:30:25 +00:00
Raymond Hettinger 170a62221c Add more docs for generator expressions.
* Put in a brief, example driven tutorial entry.
* Use better examples in whatsnew24.tex.
2004-05-19 19:45:19 +00:00
Raymond Hettinger 354433a59d SF patch #872326: Generator expression implementation
(Code contributed by Jiwon Seo.)

The documentation portion of the patch is being re-worked and will be
checked-in soon.  Likewise, PEP 289 will be updated to reflect Guido's
rationale for the design decisions on binding behavior (as described in
in his patch comments and in discussions on python-dev).

The test file, test_genexps.py, is written in doctest format and is
meant to exercise all aspects of the the patch.  Further additions are
welcome from everyone.  Please stress test this new feature as much as
possible before the alpha release.
2004-05-19 08:20:33 +00:00
Fred Drake 9f15b5c11c add some notes about the changes to ConfigParser 2004-05-18 04:30:00 +00:00
Fred Drake 82903148a8 ConfigParser:
- read() method returns a list of files parsed successfully
- add tests, documentation
(closes SF patch #677651)
2004-05-18 04:24:02 +00:00
Fred Drake b4c6091984 ConfigParser:
- DuplicateSectionError is only raised by add_section()
(closes SF bug #830449)
2004-05-18 03:56:51 +00:00
Fred Drake abc086fb0d ConfigParser:
- don't allow setting options to non-string values; raise TypeError
  when the value is set, instead of raising an arbitrary exception
  later (such as when string interpolation is performed)
- add tests, documentation
(closes SF bug #810843)
2004-05-18 03:29:52 +00:00
Fred Drake bc12b01d83 ConfigParser:
- ensure that option names in interpolations are handled by
  self.optionxform in the same way that other references to option
  names
- add tests, documentation
(closes SF bug #857881, patch #865455)
2004-05-18 02:25:51 +00:00
Raymond Hettinger 0e371f2cb6 Make sure "del d[n]" is properly supported. Was necessary because the
same method that implements __setitem__ also implements __delitem__.
Also, there were several good use cases (removing items from a queue
and implementing Forth style stack ops).
2004-05-12 20:55:56 +00:00
Fred Drake 1cd6e4dc38 fix various descriptions of "ctime"
(closes SF patch #870287)
2004-05-12 03:51:40 +00:00
Fred Drake 043fff0881 minor wording cleanup 2004-05-12 03:20:37 +00:00
Fred Drake bb066cf841 fix various typos; thanks, George Yoshida!
(closes SF patch #952047)
2004-05-12 03:07:27 +00:00
Fred Drake f72de0fb8c add note about the __name__ read-only attribute
(closes SF bug #952212)
2004-05-12 02:48:29 +00:00
Fred Drake 112f8f4f81 use tools/getversioninfo to extract the version number from the Python
sources
2004-05-11 14:37:55 +00:00
Fred Drake 6d340c3de8 remove assignment to unused variable 2004-05-11 14:25:56 +00:00
Fred Drake 3b4ab231f2 update to reflect the current location of the SF bugs search box 2004-05-11 14:14:24 +00:00
Fred Drake 0d73621cb2 markup adjustment 2004-05-11 05:29:34 +00:00
Barry Warsaw dd69b0ab6c Added a note describing how fp should be opened in binary mode, especially on
Windows.  Closes SF # 586899.
2004-05-10 23:12:52 +00:00
Skip Montanaro fb85739494 Point out that %p has no effect on the output hour in strptime unless %I is
used to parse the hour.
2004-05-10 18:53:00 +00:00
Fred Drake c7c9a3a958 don't make assumptions about $PATH in Cygwin instructions 2004-05-10 18:39:32 +00:00
Raymond Hettinger e7169eb9ed Add more examples. 2004-05-09 01:15:01 +00:00
Fred Drake 67a521ef69 note that descriptor objects must be instances of new-style types
(closes SF bug #817742)
2004-05-06 12:44:29 +00:00
Fred Drake e143bbb610 fix documentation for ContentHandler.ignorableWhitespace()
(closes SF bug #881707)
2004-05-06 03:47:48 +00:00
Fred Drake 56fcc233d3 markup adjustments 2004-05-06 02:55:35 +00:00
Martin v. Löwis 456ab1d271 Swap public and system ID in start_doctype_decl. Fixes #780300. 2004-05-06 01:54:36 +00:00
Martin v. Löwis f1f0560832 Patch #940026: Explain "in" when it is first used.
Backported to 2.3.
2004-05-06 01:35:45 +00:00
Andrew M. Kuchling 99872c1342 [Bug #810879] Document that copyfile() can fail if you don't have permissions; also, fix a double negative. 2004-05-05 17:21:51 +00:00
Brett Cannon 0fefc140aa Fix small grammatical mistake. 2004-05-05 16:49:11 +00:00
Fred Drake 8aa8c84d18 add an index entry for __getnewargs__() 2004-05-05 04:56:06 +00:00
Fred Drake 0de77d1d6e - note that __getinitargs__() is only for old-style classes
- describe __getnewargs__()
(closes SF bug #873246)
2004-05-05 04:54:37 +00:00
Fred Drake 04d92c37f2 Remove list of pickle protocol names used by the copy module; there
are enough subtleties to pickling that we don't want misunderstanding
to spread because we don't provide all the information twice.  The
reference to the pickle module for information will have to suffice;
at least only one portion of the docs will be out of date.  ;-(
2004-05-05 04:24:30 +00:00
Fred Drake cee8879a7d note that the error code for socket.gaierror will be one of the EAI_*
constants
(closes SF bug #837929)
2004-05-05 04:18:11 +00:00
Greg Ward 4fe97ca4ce SF #814606: merge from release23-maint branch: clarify/cleanup
mixer docs; trim \platform{}, add \versionadded{}.
2004-05-05 01:36:16 +00:00
Nicholas Bastin e9c2ecfb96 Removed 'U' from the documentation for Py_BuildValue to bring it in line
with the elimination of 'U' in modsupport.c on 2000/04/28 (replaced
with 'u' and 'u#' per fdrake's comments).
2004-05-04 19:25:56 +00:00
Phillip J. Eby 5068c873e6 Document readline module functions added in Python 2.3. See:
http://mail.python.org/pipermail/python-dev/2003-September/037922.html

for background.  It appears I forgot to ever submit a bug report or patch.
2004-05-04 19:20:22 +00:00
Raymond Hettinger d7911a3317 Minor documentation nits. 2004-05-01 08:31:36 +00:00
Raymond Hettinger f5f9a370d4 Add an example application to the docs. 2004-04-30 22:52:50 +00:00
Fred Drake 6fbf703fa2 the headers in an HTTP request are HTTP headers, not MIME headers 2004-04-29 02:47:38 +00:00
Fred Drake ceeb1918a1 remove out-of-date count of the functions in winsound 2004-04-28 03:57:47 +00:00
Fred Drake 6d4c7b05bb fix typo reported in a long-buried email 2004-04-28 03:16:49 +00:00
Raymond Hettinger 46a16f297f SF bug #940579: section 5.10: 'not' returns boolean, not int 2004-04-23 17:11:47 +00:00
Thomas Heller 1328b52c6f Two new public API functions, Py_IncRef and Py_DecRef. Useful for
dynamic embedders of Python.
2004-04-22 17:23:49 +00:00
Raymond Hettinger e5fced781b SF bug #936827: PyNumber_And() 's description
Fix typo.
2004-04-17 11:57:40 +00:00
Fred Drake 0ed663443e really scream out that people should use the file objects instead of
file descriptor operations for normal applications
2004-04-16 15:20:01 +00:00
Skip Montanaro 10659f2540 bring description of optional and keyword args for DictReader and DictWriter
classes into line with the actual code.  I didn't see any obvious examples
of latex formatting for *args and **kwds so I just guessed.
2004-04-16 03:21:01 +00:00
Fred Drake 8efc74d35e remove bogus markup that caused the docs to be wrong 2004-04-15 06:18:48 +00:00
Fred Drake 6b3b046ab0 fix up some markup 2004-04-09 18:26:40 +00:00
Fred Drake 94ffbb71a8 give rational filenames to some of the generated HTML 2004-04-08 19:44:31 +00:00
Fred Drake 4cc425a0a3 switch to PNG navigation icons by default 2004-04-08 18:51:39 +00:00
Fred Drake 4f580e8394 include both the GIF and PNG icons in the HTML package 2004-04-08 18:50:51 +00:00
Fred Drake 899072ab71 avoid stripping space after indexing macros 2004-04-08 15:30:12 +00:00
Neal Norwitz ba813e2089 #928751, fix typos in socket doc 2004-04-03 18:02:37 +00:00
Fred Drake 8effa01931 fix typo that wasn't properly fixed in revision 1.144 2004-04-01 04:30:29 +00:00
Fred Drake 862b46bbc1 add a heavy box around warning notices to make them really stand out in the
PDF and PostScript versions of the docs (the CSS already does this for HTML)
2004-03-31 08:08:34 +00:00
Fred Drake 90756c2da7 add missing and forthcoming releases 2004-03-31 08:04:46 +00:00
Fred Drake 34c43202eb Emphasize the requirement that Python.h be included first more strongly.
Closes SF bug #837228; backporting for Python 2.3.4.
2004-03-31 07:45:46 +00:00
Fred Drake 203b10c75a added scripts to the list of files automatically included in the
distribution (see SF bug #796042)
2004-03-31 01:50:37 +00:00
Andrew M. Kuchling aeaec8d4aa fix typo 2004-03-29 01:19:54 +00:00
Raymond Hettinger f13c024002 Insert missing pronoun 2004-03-28 22:44:09 +00:00
Skip Montanaro dbb407808a - add entry for complex number
- fix a couple typos
- refine definitions for "interpreted" and "coercion" based upon updates on
  the python glossary wiki
2004-03-27 18:23:11 +00:00
Fred Drake 8123ff6bca remove out-of-date warning 2004-03-26 17:11:10 +00:00
Raymond Hettinger 707483fdef Update timeit example to reflect current performance. 2004-03-26 07:56:23 +00:00
Fred Drake 504ca68e20 Note that reading from a socket may not always return all of the
remaining content of a stream when expected to do so.
Closes SF bug #725265.  Should be backported to Python 2.3.x.
2004-03-25 16:51:12 +00:00
Fred Drake 267b062432 - make sure the methods minidom adds to the basic DOM are attributed
to Node objects in the index (closes SF bug #832251)
- fix a variety of markup nits

Someone should backport this patch to Python 2.3.x.
2004-03-25 16:39:46 +00:00
Fred Drake ad62202a5e include the right index sources 2004-03-25 16:35:10 +00:00
Fred Drake 73789bc8f5 remove duplicate use of the meta-data label 2004-03-25 16:33:29 +00:00
Fred Drake 2f00c5453e fix typo 2004-03-25 16:14:17 +00:00
Fred Drake f39c3c7a6b note that distutils API docs are included in "Distributing Python
Modules"
2004-03-25 16:12:08 +00:00
Fred Drake d0c3b26bd0 improve the very-high-level API docs (contributed by Jeff Epler)
Closes SF patch #798638.
2004-03-25 15:44:56 +00:00
Fred Drake 85309512ec Remove note that PyErr_SetInterrupt() is obsolete; add comment about the
fact that it was marked obsolete but is still needed.
Closes SF bug #919299.  Someone else should backport this to Python 2.3.
2004-03-25 14:25:28 +00:00
Raymond Hettinger 5232f50b19 SF bug: #921927: Fixed a typo/thinko spelling "parameter" as "paramter" 2004-03-25 08:51:36 +00:00
Nicholas Bastin c69ebe8d50 Enable the profiling of C functions (builtins and extensions) 2004-03-24 21:57:10 +00:00
Fred Drake fee6f33e08 more markup nits 2004-03-23 21:40:07 +00:00
Fred Drake e05c3e0fbb fix markup nits 2004-03-23 20:30:59 +00:00
Fred Drake 4ac6c6afc3 add the distutils modules to the global modules list 2004-03-23 19:26:54 +00:00
Fred Drake 6356fff2cb give the document indexes 2004-03-23 19:02:38 +00:00
Fred Drake 630e5bd2f7 - use recommended Python style in examples (no spaces around "=" for
keyword args)
- format multi-line calls to distutils.core.setup() consistently, and
  in line with general practice (one keyword arg per line,
  comma/newline after the last
- fix a few typos
2004-03-23 18:54:12 +00:00
Nicholas Bastin 824b1b2da8 Added command line options for profile.py - one for stats output file
and one for sort order when using stdout.  Uses optparse.
2004-03-23 18:44:39 +00:00
Fred Drake 6fca7cc783 merge Anthony Baxter's distutils API reference into the package
author's documentation
2004-03-23 18:43:03 +00:00
Fred Drake 211a2eb784 convert from a howto to a manual 2004-03-22 21:44:43 +00:00
Nicholas Bastin 1eb4bfc657 Added global runctx function to profile to fix SF Bug #716587 2004-03-22 20:12:56 +00:00
Andrew M. Kuchling cbddabfd85 Remove 'now' 2004-03-21 22:12:45 +00:00
Nicholas Bastin 07973dab97 Modified string.split documentation to reflect behaviour of splitting emtpy string. Closes SF bug #811604 2004-03-21 16:59:59 +00:00
Skip Montanaro 20a8336ff7 concrete example of why retaining old objects is good 2004-03-21 16:05:30 +00:00
Brett Cannon 8b6cc2e7f2 Removed extra period from \versionchanged entry; macro adds period
automatically.
2004-03-21 14:10:18 +00:00
Brett Cannon 508c57d544 Clarify docs on where .pth files can exist. 2004-03-20 21:41:28 +00:00
Raymond Hettinger fe703e0650 SF bug #918371: hasattr()'s return type
Replace 1 and 0 with True and False.
2004-03-20 18:25:31 +00:00
Tim Peters d4079e1fc2 Update copyright years, and change copyright.tex to use the same spelling
as license.tex (SF patch 795531 complained about the spelling discrepancy,
although this "repairs" that flaw in a different way than the patch).
2004-03-20 17:24:51 +00:00
Fred Drake 9de0a2ba9d fix two typos that turned text into markup 2004-03-20 08:13:32 +00:00
Skip Montanaro 8e6ad6fbe9 Expand on the semantics of reload(). Closes #919099. 2004-03-19 15:20:16 +00:00
Hye-Shik Chang 5c5316f111 Add a new unicode codec: ptcp154 (Kazakh) 2004-03-19 08:06:07 +00:00
Raymond Hettinger ade08ea8a8 Add news entries for the dictionary optimizations. 2004-03-18 09:48:12 +00:00
Brett Cannon d1de45f549 Fix capitalization of title for subsection 2. 2004-03-18 07:37:15 +00:00
Brett Cannon 65d63424b4 Minor grammatical fixes. 2004-03-18 01:38:11 +00:00
Brett Cannon 9b976e6636 Extremely minor typo fixed. 2004-03-18 00:49:01 +00:00
Skip Montanaro bdda9f389a The example files need to be opened with the "b" flag. 2004-03-17 01:24:17 +00:00
Raymond Hettinger 49f9bd15ff SF feature request #686323: Minor array module enhancements
array.extend() now accepts iterable arguments implements as a series
of appends.  Besides being a user convenience and matching the behavior
for lists, this the saves memory and cycles that would be used to
create a temporary array object.
2004-03-14 05:43:59 +00:00
Raymond Hettinger c1e4f9dd92 Use a new macro, PySequence_Fast_ITEMS to factor out code common to
three recent optimizations.  Aside from reducing code volume, it
increases readability.
2004-03-12 08:04:00 +00:00
Hye-Shik Chang 9168c70438 SF Patch #912462: Relocate \end tag to the right place.
(Submitted by George Yoshida)
2004-03-09 05:53:15 +00:00
Raymond Hettinger b7d05db0be Optimize tuple_slice() and make further improvements to list_slice()
and list.extend().  Factoring the inner loops to remove the constant
structure references and fixed offsets gives speedups ranging from
20% to 30%.
2004-03-08 07:25:05 +00:00
Raymond Hettinger dd80f76265 SF patch #910929: Optimize list comprehensions
Add a new opcode, LIST_APPEND, and apply it to the code generation for
list comprehensions.  Reduces the per-loop overhead by about a third.
2004-03-07 07:31:06 +00:00
Raymond Hettinger 31017aed36 SF #904720: dict.update should take a 2-tuple sequence like dict.__init_
(Championed by Bob Ippolito.)

The update() method for mappings now accepts all the same argument forms
as the dict() constructor.  This includes item lists and/or keyword
arguments.
2004-03-04 08:25:44 +00:00
Raymond Hettinger 35c62e58c5 Added license notices that are required to be included in the
documentation as well as the source code.
2004-03-03 08:27:25 +00:00
Brett Cannon d1080a3418 Have strftime() check its time tuple argument to make sure the tuple's values
are within proper boundaries as specified in the docs.

This can break possible code (datetime module needed changing, for instance)
that uses 0 for values that need to be greater 1 or greater (month, day, and
day of year).

Fixes bug #897625.
2004-03-02 04:38:10 +00:00
Raymond Hettinger 0a4977c2f3 Replace left(), right(), and __reversed__() with the more general purpose
__getitem__() and __setitem__().

Simplifies the API, reduces the code size, adds flexibility, and makes
deques work with bisect.bisect(), random.shuffle(), and random.sample().
2004-03-01 23:16:22 +00:00
Raymond Hettinger 738ec90ca1 Improvements to collections.deque():
* Add doctests for the examples in the library reference.
* Add two methods, left() and right(), modeled after deques in C++ STL.
* Apply the new method to asynchat.py.
* Add comparison operators to make deques more substitutable for lists.
* Replace the LookupErrors with IndexErrors to more closely match lists.
2004-02-29 02:15:56 +00:00
Neal Norwitz fb0521f153 Use versionadded for new features 2004-02-28 16:00:23 +00:00
Neal Norwitz 3e0877ef88 Add version changed/added to doc 2004-02-28 15:19:33 +00:00
Fred Drake 59e02c110d fix typo in reference to RFC 3464 DSN MIME type 2004-02-24 20:58:10 +00:00
Fred Drake f0ae4272b4 fix English usage error reported by Ken Fuchs 2004-02-24 16:13:36 +00:00
Fred Drake 781380c1f8 - "Mac OS" should always include the space
- comment out documentation for a non-existant feature (--spec-file)
  that the comments indicate isn't clearly needed
- lots of minor markup adjustments to get a more consistent
  presentation
2004-02-19 23:17:46 +00:00
Fred Drake 2a1bc50663 - according to Apple's publication style guide, yes, "Mac people" use
the term Installer (always capitalized, however)
- generalize the text about the term "installer" in a fairly
  reasonable way
2004-02-19 23:03:29 +00:00
Fred Drake a9ee0da8f3 use API documentation style for the descriptions of the additional
functions made available in the post-installation script run by the
Windows installer
2004-02-19 22:28:15 +00:00
Fred Drake c54d9256fb minor markup improvements 2004-02-19 22:16:05 +00:00
David Ascher e2b4b32025 Implementation of patch 869468
Allow the user to create Tkinter.Tcl objects which are
just like Tkinter.Tk objects except that they do not
initialize Tk. This is useful in circumstances where the
script is being run on machines that do not have an X
server running -- in those cases, Tk initialization fails,
even if no window is ever created.

Includes documentation change and tests.

Tested on Linux, Solaris and Windows.

Reviewed by Martin von Loewis.
2004-02-18 05:59:53 +00:00
Raymond Hettinger 79b5cf1129 Mention the optimization of list.extend(). 2004-02-17 10:46:32 +00:00
Fred Drake 70a30e8c94 markup correction 2004-02-17 04:17:36 +00:00
Martin v. Löwis d3f4a1a00a Patch #893566: Document that tp_dealloc may be called from any thread. 2004-02-15 21:01:17 +00:00
Raymond Hettinger ab517d2eac Fine tune the speed/space trade-off for overallocating small lists.
The Py2.3 approach overallocated small lists by up to 8 elements.
The last checkin would limited this to one but slowed down (by 20 to 30%)
the creation of small lists between 3 to 8 elements.

This tune-up balances the two, limiting overallocation to 3 elements
(significantly reducing space consumption from Py2.3) and running faster
than the previous checkin.

The first part of the growth pattern (0, 4, 8, 16) neatly meshes with
allocators that trigger data movement only when crossing a power of two
boundary.  Also, then even numbers mesh well with common data alignments.
2004-02-14 18:34:46 +00:00
Raymond Hettinger 238b267bf6 Lists are measured in elements not bytes. 2004-02-13 21:50:27 +00:00
Raymond Hettinger 7a6d297bda * Note list optimizations
* Move an example out of a comment.
2004-02-13 19:00:07 +00:00
Fred Drake ce3caf2e7a minor markup improvements 2004-02-12 18:13:12 +00:00
Walter Dörwald 70a6b49821 Replace backticks with repr() or "%r"
From SF patch #852334.
2004-02-12 17:35:32 +00:00
Fred Drake e6ed33a6b3 fix minor markup error: \code{for} --> \keyword{for} 2004-02-12 14:35:18 +00:00
Raymond Hettinger b1e5b50531 SF 895560: minor typo 2004-02-12 09:50:42 +00:00
Fred Drake 29f5933fcb add support for \e to the {alltt} environment 2004-02-10 18:30:22 +00:00
Neal Norwitz d311f1fb9b SF #894428, fix typo 2004-02-10 18:07:16 +00:00
Fred Drake 27da291b2c the \file macro is no longer a good example of where \e can't be used 2004-02-09 21:00:29 +00:00
Fred Drake 52feb81932 support \e in \file and \filenq; this is useful for Windows paths 2004-02-09 20:58:08 +00:00
Andrew M. Kuchling fd0e494c98 Minor edits 2004-02-09 13:23:34 +00:00
Thomas Heller 8178a22e20 Documentation for PyDescr_NewClassMethod was missing - here's at least
the function prototype.

Already backported to release23-maint.
2004-02-09 10:47:11 +00:00
Raymond Hettinger 5de33786a9 SF patch #892821: example for urllib2 has SyntaxError
(Contributed by George Yoshida.)
2004-02-08 20:25:01 +00:00
Raymond Hettinger 3fd977964a Fix misspelled name. 2004-02-08 20:18:26 +00:00
Raymond Hettinger 7820554c2c Fix typo 2004-02-08 20:05:40 +00:00
Raymond Hettinger ce9b4714ef SF patch #880552: Fix typo in usage message(prechm.py)
(Contributed by George Yoshida.)

* Also convert tabs to spaces.
2004-02-08 19:24:18 +00:00
Raymond Hettinger 4c9800d663 SF bug #892854: typo in textwrap doc page
(Reported by Drew Perttula.)
2004-02-08 18:09:32 +00:00
Raymond Hettinger 5c5eb86347 * Incorporate Skip's suggestions for documentation (explain the word deque
comes from and show the differences from lists).
* Add a rotate() method.
2004-02-07 21:13:00 +00:00
Skip Montanaro 7209294112 a couple other sunos4 support items removed 2004-02-07 12:50:19 +00:00
Raymond Hettinger c058fd14a9 * Fix ref counting in extend() and extendleft().
* Let deques support reversed().
2004-02-07 02:45:22 +00:00
Raymond Hettinger 3ba85c2e8a Have deques support high volume loads. 2004-02-06 19:04:56 +00:00
Fred Drake 21ae4f983e minor markup adjustments 2004-02-03 20:55:15 +00:00
Fred Drake 4458ece4d7 Clarify minor point about the ref() and proxy() constructors.
This matches what is already documented for corresponding feature of the C API.
2004-02-03 19:44:26 +00:00
Fred Drake 4d205e366c update dependency information 2004-01-29 15:13:08 +00:00
Raymond Hettinger dd256d97cc Add documentation for collections.deque(). 2004-01-29 07:35:45 +00:00
Raymond Hettinger e52f3b1e56 Add documentation for collections.deque(). 2004-01-29 07:27:45 +00:00
Raymond Hettinger 756b3f3c15 * Move collections.deque() in from the sandbox
* Add unittests, newsitem, and whatsnew
* Apply to Queue.py mutex.py threading.py pydoc.py and shlex.py
* Docs are forthcoming
2004-01-29 06:37:52 +00:00
Fred Drake bd12b181c8 fix whitespace style (inconsistent with the rest of the docs) 2004-01-27 21:08:04 +00:00
Fred Drake fcc51767bd update signature of the socket constructor
(could someone backport this to Python 2.3.x please?)
2004-01-27 18:21:26 +00:00