Commit graph

6941 commits

Author SHA1 Message Date
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