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
Facundo Batista
139af0295c
Fixed quantize syntax.
2004-11-20 00:33:51 +00:00
Raymond Hettinger
a2325f67a1
SF patch #1068456 : small update for pdb docs
2004-11-18 08:39:33 +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
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
2269d86598
Fix SF bug #1061770 : Manual typesets bit-shift operators as guillemet
2004-11-11 06:14:05 +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
8efc80a909
- remove use of a "list" environment (replace with a table)
...
- fix minor markup nits
2004-11-11 04:39:56 +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
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
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
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
Fred Drake
3ed238503d
add missing line break
2004-10-25 21:35:17 +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
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
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
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
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
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
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
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
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
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
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
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
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
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
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