7233acc5c5
stop the versionchanged directive from hiding the docs
2009-03-29 03:31:40 +00:00
be76d4caed
a more realistic example
2009-03-29 03:16:57 +00:00
a0eea590c7
Add section numbering to some of the larger subdocuments.
2009-03-28 19:57:36 +00:00
0e9285845e
give os.symlink and os.link() better parameter names #5564
2009-03-28 19:16:10 +00:00
a31aa45fbf
#5324 : document __subclasses__().
2009-03-28 19:10:37 +00:00
47d9738b0f
rename TestCase.skip() to skipTest() because it causes annoying problems with trial #5571
2009-03-26 20:05:50 +00:00
9a1337b95e
clarify the type of data returned
2009-03-25 00:52:11 +00:00
21b617bd98
Add links to related resources.
2009-03-24 00:17:11 +00:00
31b7806ee8
forgot to document that setUp can be skipped (silly me...)
2009-03-23 23:13:36 +00:00
99721e0c44
refactor unittest docs
2009-03-23 23:10:14 +00:00
cb2b0e45d4
comply with the evilJavaNamingScheme for attribute names
...
It seems my love of PEP 8 overrode the need for consistentcy
2009-03-23 22:29:45 +00:00
692428e77f
implement test skipping and expected failures
...
patch by myself #1034053
2009-03-23 21:50:21 +00:00
f8387af262
Issue #4688 : Add a heuristic so that tuples and dicts containing only
...
untrackable objects are not tracked by the garbage collector. This can
reduce the size of collections and therefore the garbage collection overhead
on long-running programs, depending on their particular use of datatypes.
(trivia: this makes the "binary_trees" benchmark from the Computer Language
Shootout 40% faster)
2009-03-23 18:41:45 +00:00
2cef1a5409
Add MutableSet example.
2009-03-20 18:25:49 +00:00
efc82f7e8e
Issue #4258 : Use 30-bit digits for Python longs, on 64-bit platforms.
...
Backport of r70459.
2009-03-20 15:51:55 +00:00
2412299be9
* Add clearer comment to initialization code.
...
* Add optional argument to popitem() -- modeled
after Anthon van der Neut's C version.
* Fix method markup in docs.
2009-03-19 19:59:58 +00:00
91852ca673
Issue 5381: Add object_pairs_hook to the json module.
2009-03-19 19:19:03 +00:00
06919a177d
a much better example
2009-03-18 20:58:09 +00:00
ed3558b334
I thought this was begging for an example
2009-03-17 20:29:51 +00:00
8cbe9556cf
Add token markup.
2009-03-16 19:42:03 +00:00
545a134916
Fix markup in re docs and give a mail address in regex howto, so that
...
the recommendation to send suggestions to the author can be followed.
2009-03-15 21:59:37 +00:00
09827eb55e
#5276 : document IDLESTARTUP and .Idle.py.
2009-03-15 21:51:48 +00:00
8db96b5969
#5478 : fix copy-paste oversight in function signature.
2009-03-15 21:47:42 +00:00
5a95b21fee
#5491 : clarify nested() semantics.
2009-03-15 21:44:43 +00:00
e83a4adba7
#5486 : typos.
2009-03-13 19:03:58 +00:00
efa7c138b6
Issue 5477: Fix buglet in the itertools documentation.
2009-03-12 00:31:58 +00:00
6c4cff0f32
Require implementations for warnings.showwarning() support the 'line' argument.
...
Was a DeprecationWarning for not supporting it since Python 2.6.
Closes issue #3652 .
2009-03-11 04:51:06 +00:00
8f19598f78
Fix typo.
2009-03-10 13:04:30 +00:00
56411aac79
For collections.deque() objects, expose the maxlen parameter as a read-only attribute.
2009-03-10 12:50:59 +00:00
ced6b1da83
Update the decimal FAQ for the from_float() classmethod and improve the recipe for remove_exponent() to make it cut and pasteable.
2009-03-10 08:16:05 +00:00
eecd1dc6e0
Clarify the meaning of normal and subnormal.
2009-03-10 04:40:24 +00:00
f345a21d8e
Update url for the spec.
2009-03-10 01:07:30 +00:00
f4ea929044
Fix markup.
2009-03-10 00:06:05 +00:00
6d83429a1d
gzip and bz2 are context managers
2009-03-09 20:38:56 +00:00
38f1bf6745
Add missing space.
2009-03-09 16:35:48 +00:00
2cd82a8383
#5458 : add a note when we started to raise RuntimeErrors.
2009-03-09 14:25:07 +00:00
9324ed8982
Add cross-reference to the collections docs.
2009-03-09 12:56:23 +00:00
3496a89f27
Add consume() recipe to itertools docs.
2009-03-09 11:57:29 +00:00
fed84c765d
Issue 5443: Fix typo.
2009-03-09 11:31:39 +00:00
ce15a65ca7
Minor bsddb documentation glitch
2009-03-05 19:37:37 +00:00
c51ec0a9e3
add example
2009-03-05 00:17:57 +00:00
eeafb96b08
Fixed a typo.
2009-03-04 21:18:17 +00:00
d5ad6da03b
Remove obsolete stuff from string module docs.
2009-03-04 18:24:41 +00:00
288618e1a7
making the writing more formal
2009-03-03 22:51:57 +00:00
a07038d614
Fix markup.
2009-03-03 05:11:56 +00:00
e89b8e9832
Backport 70111: Let configparser use ordered dicts by default.
2009-03-03 05:00:37 +00:00
88a9164cdb
Backport 70106: Add OrderedDict support to collections.namedtuple().
2009-03-03 04:51:24 +00:00
bc512d3abd
Backport PEP 372: OrderedDict()
2009-03-03 04:45:34 +00:00
ae91d0907d
Adds an optional flags argument to re.split, re.sub and re.subn to be
...
consistent with the other re module functions.
2009-03-02 05:13:57 +00:00
0261e5d0b6
The note about caching of regular expression objects was incorrect ReST and
...
thus invisible in the compiled documentation. Fixed. Also I cleaned up the
wording.
2009-03-02 04:53:24 +00:00
3bac8b20b5
Fix docs for ConfigParser.
2009-03-01 02:04:32 +00:00
68d6852006
Backport r69961 to trunk, replacing JUMP_IF_{TRUE,FALSE} with
...
POP_JUMP_IF_{TRUE,FALSE} and JUMP_IF_{TRUE,FALSE}_OR_POP. This avoids executing
a POP_TOP on each conditional and sometimes allows the peephole optimizer to
skip a JUMP_ABSOLUTE entirely. It speeds up list comprehensions significantly.
2009-02-28 19:03:21 +00:00
02172ddbee
Binary flag is needed on windows.
2009-02-28 15:24:00 +00:00
5c189b16a8
#5365 : add quick look conversion table for different time representations.
2009-02-27 16:59:03 +00:00
ee6361f7d8
#5363 : fix cmpfiles() docs. Another instance where a prose description is twice as long as the code.
2009-02-27 16:39:26 +00:00
da2790c47d
#5361 : fix typo.
2009-02-27 16:23:18 +00:00
13813f7092
Document that setting sys.py3kwarning wont do anything.
2009-02-26 17:36:26 +00:00
a168698ab3
fix str.format()'s first arg #5371
2009-02-26 00:30:11 +00:00
ed955f108f
Fix typo.
2009-02-26 00:05:24 +00:00
a665853bab
Clarify Counter() docs.
2009-02-25 22:48:24 +00:00
afe496dc46
Remove reference to zero argument form of super() in 2.x docs.
2009-02-25 01:06:52 +00:00
b762d58544
More markup and spelling fixes.
2009-02-25 00:52:37 +00:00
eb7cbb94c5
Restore Py2.x version of sample call to super().
2009-02-25 00:39:47 +00:00
9766033b7c
Sync-up py3.1 doc updates for super().
2009-02-25 00:37:57 +00:00
d47442e3cb
Update itertools recipes to use next().
2009-02-23 19:32:55 +00:00
52bc7b85fd
Fix grammar.
2009-02-23 18:33:48 +00:00
de196911f1
#5352 : str.count() counts non-overlapping instances.
2009-02-23 15:51:27 +00:00
89d4f0d7c5
#5349 : C++ pure virtuals can also have an implementation.
2009-02-23 11:24:46 +00:00
528f8810aa
#5348 : format() converts all kinds of values.
2009-02-23 10:24:23 +00:00
3e4caeb3bf
Issue #5341 : Fix a variety of spelling errors.
2009-02-21 20:27:01 +00:00
8b8c2df9b1
Fix punctuation.
2009-02-20 08:45:47 +00:00
6b5dbaa6c9
At least separate imports from other statements.
2009-02-20 08:22:21 +00:00
a7b55a33f8
revert r69777 since all the experts agree that extra import lines distract from the code
2009-02-20 03:31:23 +00:00
5149742e8b
Since we recommend one module per import line, reflect this also in the
...
documentation.
2009-02-19 18:52:21 +00:00
749e6d0a01
Add links to helpful external resources.
2009-02-19 06:55:03 +00:00
7d854955e1
Add an example for math.fsum() and elaborate on the accurary note.
2009-02-19 05:51:41 +00:00
f9bce83e71
Add some cross-references to the docs. Simplify the python code equivalent for izip(). Supply an optional argument for the nth() recipe.
2009-02-19 05:34:35 +00:00
c8223b09b0
Generalize the itertools.tee() recipe.
2009-02-18 20:54:53 +00:00
8367becc02
Clarify socket timeout behavior vs system network stack behavior on connect
...
for issue5293.
2009-02-18 05:46:11 +00:00
580d7c1f57
#5268 : mention VMSError.
2009-02-18 00:31:36 +00:00
52f6b6d500
#5297 : fix example.
2009-02-18 00:22:55 +00:00
1d0b5cc6dc
Clarify the deprecation of platform.dist().
...
Add versionadded tags.
2009-02-17 12:48:19 +00:00
0aee942a08
Fixup intro paragraphs for the itertools docs. Add some tables for quick reference.
2009-02-17 11:00:27 +00:00
f746a1f1e4
Fix-up intro paragraph for collections docs.
2009-02-17 08:33:01 +00:00
7c98a6d4dc
Add explanation for super(type1, type2).
2009-02-16 23:00:25 +00:00
fd04870a3d
Issue 5229: Documentation for super() neglects to say what super() actually does
2009-02-16 22:42:54 +00:00
5b8c701eef
Fixed typo.
2009-02-15 09:19:48 +00:00
a4038038c6
Add keyword argument support to itertools.count().
2009-02-14 00:25:51 +00:00
5ccf2ae21c
#1661108 : note that urlsafe encoded string can contain "=".
2009-02-13 10:56:50 +00:00
8fba5b337c
#4894 : document "newurl" parameter to redirect_request().
2009-02-13 10:40:14 +00:00
31c769ca89
Issue 5032: added a step argument to itertools.count() and allowed non-integer arguments.
2009-02-12 05:39:46 +00:00
1312b4bcfd
os.fsync() should be used to ensure that data is written to disk
2009-02-12 03:50:00 +00:00
e4ae63c402
Clean-up named tuple docs.
2009-02-11 00:06:17 +00:00
322daea7c3
Issue 1818: collections.namedtuple() to support automatic renaming of invalid fieldnames.
2009-02-10 01:24:05 +00:00
b8e17f7370
a few edits and typos
2009-02-08 15:14:57 +00:00
c5e68b1898
document numliterals fixer
2009-02-08 14:38:13 +00:00
0194f5bc98
Issue #4512 closeout: Make ZipImport.get_filename() a public method
2009-02-08 03:17:00 +00:00
d39600e69f
Issue 4195: Restore the ability to execute packages with the -m switch (but this time in a way that leaves the import machinery in a valid state). (Original patch by Andi Vajda)
2009-02-08 01:26:34 +00:00
e0820e2ea7
document individual 2to3 fixers
2009-02-07 23:01:19 +00:00
95f8ef2825
make "super only for new-style classes" a note.
2009-02-07 18:49:54 +00:00
34feea3205
#5174 : fix wrong file closing in example.
2009-02-07 12:21:17 +00:00
81fe09344c
Implement issue #4285 , convert sys.version_info to a named
...
tuple. Patch by Ross Light.
2009-02-06 00:48:26 +00:00
ecd2afa452
#5031 : fix Thread.daemon property docs.
2009-02-05 11:40:35 +00:00
2b0dd8e199
#4820 : use correct module for ctypes.util.
2009-02-05 11:35:28 +00:00
253a29fa4d
#4827 : fix callback example.
2009-02-05 11:33:21 +00:00
b21c75beab
#5059 : fix example.
2009-02-05 10:59:28 +00:00
174fbe7742
#5153 : fix typo in example.
2009-02-05 10:30:57 +00:00
939a3cc5a2
Tweak the docs for Counter() objects.
2009-02-04 11:31:30 +00:00
8184f5a46c
Doc fixes. Remove overbroad, redundant warnings. Fixup example code.
2009-02-04 11:14:18 +00:00
d507afdc81
Minor doc fixups.
2009-02-04 10:52:32 +00:00
4a1b62a555
Record operator deprecations in docs.
2009-02-03 03:18:14 +00:00
86cc5029dc
wording for for issue4903.
2009-02-01 00:24:21 +00:00
5501d65590
Update doc wording as suggested in issue4903.
2009-02-01 00:16:01 +00:00
4829136965
fix indentation
2009-01-31 20:01:48 +00:00
8c2f85c43e
Text edits and markup fixes
2009-01-31 03:26:02 +00:00
8aa2c6ce8e
Minor spelling mistake in datetime docs.
2009-01-29 00:54:32 +00:00
1712baa852
Correct docs for ABCs (MutableSequence was missing __setiem). Simplify the table by taking out inherited requirements for abstract methods.
2009-01-28 23:58:16 +00:00
cda93aafde
Added the ttk module. See issue #2983 : Ttk support for Tkinter.
2009-01-28 13:09:03 +00:00
d081abc8be
Promote combinations_with_replacement() from a recipe to a regular itertool.
2009-01-27 02:58:49 +00:00
22bfa9e3e8
Tweak column alignment for collections docs.
2009-01-27 02:36:33 +00:00
93881c6c58
Backport importlib in the form of providing importlib.import_module(). This has
...
been done purely to help transitions from 2.7 to 3.1.
2009-01-26 01:16:50 +00:00
68d919e4d6
Improved itertools recipe for generating powerset().
2009-01-25 21:31:47 +00:00
2bcb8e9b0d
Promote compress() from a recipe to being a regular itertool.
2009-01-25 21:04:14 +00:00
b5a4b0abed
Properly document multiprocessing's logging support, resolve outstanding issues with the custom levels
2009-01-25 03:36:13 +00:00
403c6632e6
Issue 4593: apply() documentation is unclear
2009-01-22 21:53:22 +00:00
7bdca05a3b
More doc tweaks.
2009-01-22 05:20:47 +00:00
0a1f7b8f72
Tighten-up the docs for Counter().
2009-01-21 23:12:51 +00:00
4571f347f9
Simplify explanation of multiset operations by removing restrictions on negative inputs.
2009-01-21 20:31:50 +00:00
42ffbdb903
Markup fixes
2009-01-21 02:16:26 +00:00
acdc84abcf
Beautify and cleanup the references section.
2009-01-20 23:42:54 +00:00
196a0f7a8a
Fix typos.
2009-01-20 12:59:36 +00:00
230dd27628
Don't disrupt automatic url target name generation
...
with manually specified, conflicting names.
Before:
http://docs.python.org/dev/library/collections.html#id1
After:
http://docs.python.org/dev/library/collections.html#counter-objects
2009-01-20 07:11:47 +00:00
bad1eb2ff3
Build-outs for Counter() class:
...
* Constructor and update() support keyword args (like their dict counterparts).
* The 'del' statement no longer raises KeyError for missing values.
* Add multiset operations: __add__, __sub__, __and__, __or__.
2009-01-20 01:19:26 +00:00
c84ebe73a7
add email address
2009-01-19 16:18:27 +00:00
b6c7beb722
move BufferedIOBase into the base class section
2009-01-19 16:17:54 +00:00
4b78233cbd
Added more cross-reference targets and tidied up list of useful handlers.
2009-01-19 06:49:19 +00:00
af9a97b245
#4923 : clarify what was added.
2009-01-18 14:41:52 +00:00
9f7fb849df
#4979 : correct result range for some random functions.
2009-01-18 13:24:10 +00:00
bb550c99cb
#4914 : trunc is in math.
2009-01-18 10:48:16 +00:00
79f722da6c
#4974 : fix redundant mention of lists and tuples.
2009-01-18 10:45:22 +00:00
6c81b54cc4
#4976 : union() and intersection() take multiple args, but talk about "the other".
2009-01-18 10:42:35 +00:00
6ab22154dd
Resolve issue 4449: AssertionError in mp_benchmarks.py
2009-01-18 02:45:38 +00:00
757d25526a
Change an example in the docs to avoid a mistake when the code is copy
...
pasted and changed afterwards.
2009-01-16 18:53:44 +00:00
b1a15e489a
Minor changes/corrections in markup.
2009-01-15 23:04:47 +00:00
b5902e6054
Made minor changes/corrections in markup. Added a couple of section headings.
2009-01-15 22:48:13 +00:00
2950bca89c
Fix-up indentation of sample code blocks for namedtuple mthod definitions.
2009-01-14 01:39:51 +00:00
59894127e4
Minor doc tweaks.
2009-01-14 00:15:21 +00:00
847c43a22d
Note that first coord. is left alone
2009-01-13 13:40:54 +00:00
fbcf749479
Add table of idioms/patterns for using Counter objects.
...
Improve the appearance and flow of the References section -- it used
to have a box around it that wasn't distinct from the preceding code
boxes and it had a weird bolding pattern and hanging indents that
made the section disproportionately large.
2009-01-13 08:38:14 +00:00
8278385a05
Minor documentation tweaks and simpler update() example.
2009-01-13 03:49:43 +00:00
5a0c864045
small logic correction
2009-01-13 01:49:10 +00:00
aaa6e630f8
Simplify Counter() API. Replace items keyword argument
...
with a mapping. Makes Counter() idempotent, makes update()
API the same as Counter.__init__(), makes a more readable
repr, makes the API more dict-like, and allows Steven
Bethard's update() example to work.
2009-01-13 01:05:03 +00:00
f94d7fa5fb
Issue 1696199: Add collections.Counter().
2009-01-12 22:58:41 +00:00
99234c5c74
Minor changes/corrections in markup.
2009-01-12 20:36:18 +00:00
51a37034db
add email addresses
2009-01-11 19:48:15 +00:00
987735c4ec
Update the documentation for binascii and zlib crc32/adler32 functions
...
to better describe the signed vs unsigned return value behavior on
different platforms and versions of python. Mention the workaround to
make them all return the same thing by using & 0xffffffff.
Fixes issue4903.
Also needs to be merged into release26-maint, release30-maint, & py3k.
2009-01-11 17:57:54 +00:00
26f8d1bbe2
correct email address
2009-01-11 17:53:33 +00:00
5ed4f6cfb9
macos 9 isn't supported
2009-01-10 23:49:08 +00:00
4db53b212c
move seealso to a more appropiate place
2009-01-10 23:41:59 +00:00
c2211adcc1
Corrected minor typo and added .currentmodule directives to fix missing cross-references.
2009-01-10 19:22:57 +00:00
7c303e9a98
Corrected an incorrect self-reference.
2009-01-10 13:42:04 +00:00
99505c841e
Minor documentation changes cross-referencing NullHandler to the documentation on configuring logging in a library.
2009-01-10 13:38:04 +00:00
5b913e31a1
Forward port r68394 for issue 4816.
2009-01-08 06:39:04 +00:00
e6dc53120d
Issue #4869 : clarify documentation for random.expovariate.
2009-01-07 17:48:33 +00:00
f0d2c3f730
Issue #4272 : Add an optional argument to the GzipFile constructor to override the timestamp in the gzip stream.
2009-01-04 21:29:23 +00:00
dd7e313035
Fix two issues found by the suspicious builder.
2009-01-04 10:24:09 +00:00
775aa4a026
Test commit.
2009-01-04 08:26:10 +00:00
8c8cc6b392
Manually merge r67868 from 2.6 branch.
2009-01-03 22:05:22 +00:00
fe427895b5
Manually merge r68095,68186,68187,68188,68190 from 2.6 branch.
2009-01-03 22:03:11 +00:00
7044b11818
Remove tabs from the documentation.
2009-01-03 21:04:55 +00:00
c62ef8b4d9
Remove trailing whitespace.
2009-01-03 20:55:06 +00:00
e92818f58c
Fix uses of the default role.
2009-01-03 20:47:01 +00:00
a24067e8b3
Fix role name.
2009-01-03 20:15:14 +00:00
aa5bb329fd
Make indentation consistent.
2009-01-03 19:44:48 +00:00
f4d8597a59
Issue 4796: Add from_float methods to the decimal module.
2009-01-03 19:02:23 +00:00
edd7d95581
Fix indentation.
2009-01-03 14:29:53 +00:00
44e1581df3
Issue #4615 . Document how to use itertools for de-duping.
2009-01-02 21:26:45 +00:00
fc29f27c16
#4811 : fix markup glitches (mostly remains of the conversion),
...
found by Gabriel Genellina.
2009-01-02 20:25:14 +00:00
511048673f
Minor documentation changes relating to NullHandler, the module used for handlers and references to ConfigParser.
2009-01-02 18:53:04 +00:00
8ea999930c
fix highlighting
2009-01-01 16:43:12 +00:00
4ba9f412bf
#4767 : Use correct submodules for all MIME classes.
2009-01-01 13:14:49 +00:00
430effb6a9
Handlers are in the `logging.handlers` module.
2009-01-01 13:05:13 +00:00
914fc88cdc
#4782 : Fix markup error that hid load() and loads().
2009-01-01 12:53:19 +00:00
07bfe45730
#4784 : ... on three counts ...
2009-01-01 12:52:29 +00:00
3f74f57d76
Point to types module in new module deprecation notice.
2009-01-01 12:43:33 +00:00
775c307068
#4222 : document dis.findlabels() and dis.findlinestarts() and
...
put them into dis.__all__.
2009-01-01 12:09:40 +00:00
d0eb8f9692
#4156 : make clear that "protocol" is to be replaced with the protocol name.
2009-01-01 11:53:55 +00:00
fb22263586
#4100 : note that element children are not necessarily present on "start" events.
2009-01-01 11:46:51 +00:00
3bcb0ce922
#4778 : attributes can't be called.
2008-12-30 10:15:49 +00:00
7cc9755cfb
Minor documentation change relating to NullHandler.
2008-12-30 07:01:25 +00:00
cc928de44f
wrong version number in doc changes committed in r67979
2008-12-28 14:24:29 +00:00
697ca3d0cb
Issue #4444 : Allow assertRaises() to be used as a context handler.
2008-12-28 14:09:36 +00:00
fbaeca70e5
fix markup
2008-12-27 22:18:58 +00:00
1ffbfbc566
#4671 : document that pydoc imports modules.
2008-12-27 19:11:15 +00:00
6b28f394a2
Use :samp: role.
2008-12-27 19:06:04 +00:00
f5b04fc65e
#4695 : fix backslashery.
2008-12-27 19:04:44 +00:00
348fa7968b
#4754 : improve winsound documentation.
2008-12-27 18:49:19 +00:00
bedc343145
#4752 : actually use custom handler in example.
2008-12-27 17:42:40 +00:00
6f193e0e95
Issue #4756 : zipfile.is_zipfile() now supports file-like objects.
...
Patch by Gabriel Genellina.
2008-12-27 15:43:12 +00:00
9de7298102
remove redundant sentence
2008-12-20 22:49:24 +00:00
Benjamin Peterson
Georg Brandl
Skip Montanaro
Raymond Hettinger
Antoine Pitrou
Mark Dickinson
Brett Cannon
Jesus Cea
Facundo Batista
Gregory P. Smith
Jeffrey Yasskin
Hirokazu Yamamoto
Jeroen Ruigrok van der Werven
Marc-André Lemburg
Nick Coghlan
Eric Smith
Andrew M. Kuchling
Guilherme Polo
Jesse Noller
Vinay Sajip
Thomas Heller