Commit Graph

1087 Commits

Author SHA1 Message Date
Georg Brandl b21c75beab #5059: fix example. 2009-02-05 10:59:28 +00:00
Georg Brandl 174fbe7742 #5153: fix typo in example. 2009-02-05 10:30:57 +00:00
Raymond Hettinger 939a3cc5a2 Tweak the docs for Counter() objects. 2009-02-04 11:31:30 +00:00
Raymond Hettinger 8184f5a46c Doc fixes. Remove overbroad, redundant warnings. Fixup example code. 2009-02-04 11:14:18 +00:00
Raymond Hettinger d507afdc81 Minor doc fixups. 2009-02-04 10:52:32 +00:00
Raymond Hettinger 4a1b62a555 Record operator deprecations in docs. 2009-02-03 03:18:14 +00:00
Gregory P. Smith 86cc5029dc wording for for issue4903. 2009-02-01 00:24:21 +00:00
Gregory P. Smith 5501d65590 Update doc wording as suggested in issue4903. 2009-02-01 00:16:01 +00:00
Benjamin Peterson 4829136965 fix indentation 2009-01-31 20:01:48 +00:00
Andrew M. Kuchling 8c2f85c43e Text edits and markup fixes 2009-01-31 03:26:02 +00:00
Brett Cannon 8aa2c6ce8e Minor spelling mistake in datetime docs. 2009-01-29 00:54:32 +00:00
Raymond Hettinger 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
Guilherme Polo cda93aafde Added the ttk module. See issue #2983: Ttk support for Tkinter. 2009-01-28 13:09:03 +00:00
Raymond Hettinger d081abc8be Promote combinations_with_replacement() from a recipe to a regular itertool. 2009-01-27 02:58:49 +00:00
Raymond Hettinger 22bfa9e3e8 Tweak column alignment for collections docs. 2009-01-27 02:36:33 +00:00
Brett Cannon 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
Raymond Hettinger 68d919e4d6 Improved itertools recipe for generating powerset(). 2009-01-25 21:31:47 +00:00
Raymond Hettinger 2bcb8e9b0d Promote compress() from a recipe to being a regular itertool. 2009-01-25 21:04:14 +00:00
Jesse Noller b5a4b0abed Properly document multiprocessing's logging support, resolve outstanding issues with the custom levels 2009-01-25 03:36:13 +00:00
Jesse Noller 403c6632e6 Issue 4593: apply() documentation is unclear 2009-01-22 21:53:22 +00:00
Raymond Hettinger 7bdca05a3b More doc tweaks. 2009-01-22 05:20:47 +00:00
Raymond Hettinger 0a1f7b8f72 Tighten-up the docs for Counter(). 2009-01-21 23:12:51 +00:00
Raymond Hettinger 4571f347f9 Simplify explanation of multiset operations by removing restrictions on negative inputs. 2009-01-21 20:31:50 +00:00
Andrew M. Kuchling 42ffbdb903 Markup fixes 2009-01-21 02:16:26 +00:00
Raymond Hettinger acdc84abcf Beautify and cleanup the references section. 2009-01-20 23:42:54 +00:00
Raymond Hettinger 196a0f7a8a Fix typos. 2009-01-20 12:59:36 +00:00
Raymond Hettinger 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
Raymond Hettinger 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
Benjamin Peterson c84ebe73a7 add email address 2009-01-19 16:18:27 +00:00
Benjamin Peterson b6c7beb722 move BufferedIOBase into the base class section 2009-01-19 16:17:54 +00:00
Vinay Sajip 4b78233cbd Added more cross-reference targets and tidied up list of useful handlers. 2009-01-19 06:49:19 +00:00
Georg Brandl af9a97b245 #4923: clarify what was added. 2009-01-18 14:41:52 +00:00
Georg Brandl 9f7fb849df #4979: correct result range for some random functions. 2009-01-18 13:24:10 +00:00
Georg Brandl bb550c99cb #4914: trunc is in math. 2009-01-18 10:48:16 +00:00
Georg Brandl 79f722da6c #4974: fix redundant mention of lists and tuples. 2009-01-18 10:45:22 +00:00
Georg Brandl 6c81b54cc4 #4976: union() and intersection() take multiple args, but talk about "the other". 2009-01-18 10:42:35 +00:00
Jesse Noller 6ab22154dd Resolve issue 4449: AssertionError in mp_benchmarks.py 2009-01-18 02:45:38 +00:00
Thomas Heller 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
Vinay Sajip b1a15e489a Minor changes/corrections in markup. 2009-01-15 23:04:47 +00:00
Vinay Sajip b5902e6054 Made minor changes/corrections in markup. Added a couple of section headings. 2009-01-15 22:48:13 +00:00
Raymond Hettinger 2950bca89c Fix-up indentation of sample code blocks for namedtuple mthod definitions. 2009-01-14 01:39:51 +00:00
Raymond Hettinger 59894127e4 Minor doc tweaks. 2009-01-14 00:15:21 +00:00
Andrew M. Kuchling 847c43a22d Note that first coord. is left alone 2009-01-13 13:40:54 +00:00
Raymond Hettinger 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
Raymond Hettinger 8278385a05 Minor documentation tweaks and simpler update() example. 2009-01-13 03:49:43 +00:00
Benjamin Peterson 5a0c864045 small logic correction 2009-01-13 01:49:10 +00:00
Raymond Hettinger 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
Raymond Hettinger f94d7fa5fb Issue 1696199: Add collections.Counter(). 2009-01-12 22:58:41 +00:00
Vinay Sajip 99234c5c74 Minor changes/corrections in markup. 2009-01-12 20:36:18 +00:00
Benjamin Peterson 51a37034db add email addresses 2009-01-11 19:48:15 +00:00
Gregory P. Smith 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
Gregory P. Smith 26f8d1bbe2 correct email address 2009-01-11 17:53:33 +00:00
Benjamin Peterson 5ed4f6cfb9 macos 9 isn't supported 2009-01-10 23:49:08 +00:00
Benjamin Peterson 4db53b212c move seealso to a more appropiate place 2009-01-10 23:41:59 +00:00
Vinay Sajip c2211adcc1 Corrected minor typo and added .currentmodule directives to fix missing cross-references. 2009-01-10 19:22:57 +00:00
Vinay Sajip 7c303e9a98 Corrected an incorrect self-reference. 2009-01-10 13:42:04 +00:00
Vinay Sajip 99505c841e Minor documentation changes cross-referencing NullHandler to the documentation on configuring logging in a library. 2009-01-10 13:38:04 +00:00
Raymond Hettinger 5b913e31a1 Forward port r68394 for issue 4816. 2009-01-08 06:39:04 +00:00
Mark Dickinson e6dc53120d Issue #4869: clarify documentation for random.expovariate. 2009-01-07 17:48:33 +00:00
Antoine Pitrou 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
Georg Brandl dd7e313035 Fix two issues found by the suspicious builder. 2009-01-04 10:24:09 +00:00
Georg Brandl 775aa4a026 Test commit. 2009-01-04 08:26:10 +00:00
Georg Brandl 8c8cc6b392 Manually merge r67868 from 2.6 branch. 2009-01-03 22:05:22 +00:00
Georg Brandl fe427895b5 Manually merge r68095,68186,68187,68188,68190 from 2.6 branch. 2009-01-03 22:03:11 +00:00
Georg Brandl 7044b11818 Remove tabs from the documentation. 2009-01-03 21:04:55 +00:00
Georg Brandl c62ef8b4d9 Remove trailing whitespace. 2009-01-03 20:55:06 +00:00
Georg Brandl e92818f58c Fix uses of the default role. 2009-01-03 20:47:01 +00:00
Georg Brandl a24067e8b3 Fix role name. 2009-01-03 20:15:14 +00:00
Georg Brandl aa5bb329fd Make indentation consistent. 2009-01-03 19:44:48 +00:00
Raymond Hettinger f4d8597a59 Issue 4796: Add from_float methods to the decimal module. 2009-01-03 19:02:23 +00:00
Georg Brandl edd7d95581 Fix indentation. 2009-01-03 14:29:53 +00:00
Raymond Hettinger 44e1581df3 Issue #4615. Document how to use itertools for de-duping. 2009-01-02 21:26:45 +00:00
Georg Brandl fc29f27c16 #4811: fix markup glitches (mostly remains of the conversion),
found by Gabriel Genellina.
2009-01-02 20:25:14 +00:00
Vinay Sajip 511048673f Minor documentation changes relating to NullHandler, the module used for handlers and references to ConfigParser. 2009-01-02 18:53:04 +00:00
Benjamin Peterson 8ea999930c fix highlighting 2009-01-01 16:43:12 +00:00
Georg Brandl 4ba9f412bf #4767: Use correct submodules for all MIME classes. 2009-01-01 13:14:49 +00:00
Georg Brandl 430effb6a9 Handlers are in the `logging.handlers` module. 2009-01-01 13:05:13 +00:00
Georg Brandl 914fc88cdc #4782: Fix markup error that hid load() and loads(). 2009-01-01 12:53:19 +00:00
Georg Brandl 07bfe45730 #4784: ... on three counts ... 2009-01-01 12:52:29 +00:00
Georg Brandl 3f74f57d76 Point to types module in new module deprecation notice. 2009-01-01 12:43:33 +00:00
Georg Brandl 775c307068 #4222: document dis.findlabels() and dis.findlinestarts() and
put them into dis.__all__.
2009-01-01 12:09:40 +00:00
Georg Brandl d0eb8f9692 #4156: make clear that "protocol" is to be replaced with the protocol name. 2009-01-01 11:53:55 +00:00
Georg Brandl fb22263586 #4100: note that element children are not necessarily present on "start" events. 2009-01-01 11:46:51 +00:00
Georg Brandl 3bcb0ce922 #4778: attributes can't be called. 2008-12-30 10:15:49 +00:00
Vinay Sajip 7cc9755cfb Minor documentation change relating to NullHandler. 2008-12-30 07:01:25 +00:00
Antoine Pitrou cc928de44f wrong version number in doc changes committed in r67979 2008-12-28 14:24:29 +00:00
Antoine Pitrou 697ca3d0cb Issue #4444: Allow assertRaises() to be used as a context handler. 2008-12-28 14:09:36 +00:00
Benjamin Peterson fbaeca70e5 fix markup 2008-12-27 22:18:58 +00:00
Georg Brandl 1ffbfbc566 #4671: document that pydoc imports modules. 2008-12-27 19:11:15 +00:00
Georg Brandl 6b28f394a2 Use :samp: role. 2008-12-27 19:06:04 +00:00
Georg Brandl f5b04fc65e #4695: fix backslashery. 2008-12-27 19:04:44 +00:00
Georg Brandl 348fa7968b #4754: improve winsound documentation. 2008-12-27 18:49:19 +00:00
Georg Brandl bedc343145 #4752: actually use custom handler in example. 2008-12-27 17:42:40 +00:00
Antoine Pitrou 6f193e0e95 Issue #4756: zipfile.is_zipfile() now supports file-like objects.
Patch by Gabriel Genellina.
2008-12-27 15:43:12 +00:00
Benjamin Peterson 9de7298102 remove redundant sentence 2008-12-20 22:49:24 +00:00
Benjamin Peterson 4f6ec9d9ff add headings 2008-12-20 02:51:26 +00:00
Benjamin Peterson 2d54e72a62 copy sentence from docstring 2008-12-20 02:48:02 +00:00
Mark Dickinson 4b3ed5d8ba Fix typo in Python equivalent for bit_length. 2008-12-19 17:46:51 +00:00
Raymond Hettinger ba666a59db Fix-up and clean-up docs for int.bit_length().
* Replace dramatic footnote with in-line comment about possible round-off errors in logarithms of large numbers.
* Add comments to the pure python code equivalent.
* replace floor() with int() in the mathematical equivalent so the type is correct (should be an int, not a float).
* add abs() to the mathematical equivalent so that it matches the previous line that it is supposed to be equivalent to.
* make one combined example with a negative input.
2008-12-19 09:06:07 +00:00
Benjamin Peterson 2b97b71b6f _call_method -> _callmethod and _get_value to _getvalue 2008-12-19 02:31:35 +00:00
Benjamin Peterson dd5312d62d fix typo 2008-12-19 02:28:56 +00:00
Mark Dickinson 1a707981c8 Issue #3439: add bit_length method to int and long.
Thanks Fredrik Johansson and Victor Stinner for code,
Raymond Hettinger for review.
2008-12-17 16:14:37 +00:00
Antoine Pitrou d0c3515bc5 Issue #2183: Simplify and optimize bytecode for list comprehensions. 2008-12-17 00:38:28 +00:00
Georg Brandl 60b2e38b68 #4568: remove limitation in varargs callback example. 2008-12-15 09:07:39 +00:00
Benjamin Peterson d729aada6a specify how things are copied 2008-12-09 02:03:03 +00:00
Georg Brandl f8668ce473 #4457: rewrite __import__() documentation. 2008-12-07 22:42:09 +00:00
Georg Brandl f5d5a66349 Follow-up to #4488: document PIPE and STDOUT properly. 2008-12-06 11:57:12 +00:00
Georg Brandl 248e172ff8 Move __import__ to the bottom of the functions list.
It doesn't make sense for such a fundamental document to have
the most obscure function listed at the top.
2008-12-05 15:52:20 +00:00
Georg Brandl 95a840b044 #3171: document that *slice are removed in 3k. 2008-12-05 15:42:03 +00:00
Georg Brandl 905e0f65ba #4478: document that copyfile() can raise Error. 2008-12-05 15:32:29 +00:00
Georg Brandl e70ff4bf0d #4441 followup: Add link to open() docs for Windows. 2008-12-05 09:25:32 +00:00
Georg Brandl 8d6c49047f Use markup. 2008-12-05 09:13:45 +00:00
Georg Brandl 0c880bd4fb #4441: improve doc for os.open() flags. 2008-12-05 08:02:17 +00:00
Georg Brandl 5b5f273640 #4409: fix asterisks looking like footnotes. 2008-12-05 07:52:26 +00:00
Georg Brandl b46f0d788c #4408: document regex.groups. 2008-12-05 07:49:49 +00:00
Gregory P. Smith 26576801a6 rename the new check_call_output to check_output. its less ugly. 2008-12-05 02:27:01 +00:00
Georg Brandl 1743201364 Clarification to avoid confusing output with file descriptors. 2008-12-04 21:28:16 +00:00
Gregory P. Smith 97f49f4be7 Adds a subprocess.check_call_output() function to return the output from a
process on success or raise an exception on error.
2008-12-04 20:21:09 +00:00
Georg Brandl 32d1408192 Add another heapq example. 2008-12-04 18:59:16 +00:00
Vinay Sajip 213faca204 Issue #4384: Added logging integration with warnings module using captureWarnings(). This change includes a NullHandler which does nothing; it will be of use to library developers who want to avoid the "No handlers could be found for logger XXX" message which can appear if the library user doesn't configure logging. 2008-12-03 23:22:58 +00:00
Benjamin Peterson 4f21f985eb StringIO.close() stops you from using the buffer, too 2008-11-30 03:07:33 +00:00
Jesse Noller a280fd72e7 mp docs - fix issues 4012,3518,4193 2008-11-28 18:22:54 +00:00
Benjamin Peterson 78f98a4d7a fix typo in sqlite3 docs 2008-11-26 17:39:17 +00:00
Georg Brandl 623429132e #4404: make clear what "path" is. 2008-11-24 19:56:47 +00:00
Georg Brandl df9bcf1196 Fix typo. 2008-11-24 16:16:07 +00:00
Benjamin Peterson 39ff59e577 replace reference to debugger-hooks 2008-11-24 01:16:29 +00:00
Georg Brandl 0b9999c079 #4399: fix typo. 2008-11-23 21:57:30 +00:00
Georg Brandl 061d2e2ee9 #4392: fix parameter name. 2008-11-23 19:17:25 +00:00
Georg Brandl b053f991b4 #4364: fix attribute name on ctypes object. 2008-11-22 08:34:14 +00:00
Amaury Forgeot d'Arc 322656596a Fixed issue #4233.
Changed semantic of _fileio.FileIO's close()  method on file objects with closefd=False.
The file descriptor is still kept open but the file object behaves like a closed file.
The FileIO  object also got a new readonly attribute closefd.

Approved by Barry

Backport of r67106 from the py3k branch
2008-11-20 23:34:31 +00:00
Benjamin Peterson 050f4adcb4 fix indentation and a sphinx warning 2008-11-20 21:25:31 +00:00
Benjamin Peterson 5ab9c3badb move useful sys.settrace information to the function's documentation from the debugger 2008-11-20 04:05:12 +00:00
Brett Cannon 031f3fb69a Clarify the docs for the 'strict' argument to httplib.HTTPConnection. 2008-11-15 22:33:25 +00:00
Georg Brandl ee1a7da135 #4324: fix getlocale() argument. 2008-11-15 08:10:04 +00:00
Benjamin Peterson c4d39b2507 use correct name 2008-11-11 21:56:06 +00:00
Benjamin Peterson 942e4779b0 clarify what was added 2008-11-08 17:07:06 +00:00
Benjamin Peterson 728c6f6d34 move context clue to versionchanged tag 2008-11-08 17:04:18 +00:00
Benjamin Peterson d923f987d1 a few compile() and ast doc improvements 2008-11-08 16:55:33 +00:00
Georg Brandl 01ba86af46 #4245: move Thread section to the top. 2008-11-06 10:20:49 +00:00
Georg Brandl b9bfea712f #4267: small fixes in sqlite3 docs. 2008-11-06 10:19:11 +00:00
Georg Brandl 8986706efa #4268: Use correct module for two toplevel functions. 2008-11-06 10:17:58 +00:00
Georg Brandl ad1cb66b28 #4167: fix markup glitches. 2008-11-04 20:49:35 +00:00
Benjamin Peterson accb38c74f clarify by splitting into multiple paragraphs 2008-11-03 20:43:20 +00:00
Benjamin Peterson 8928a7e911 rephrase has_key doc 2008-10-31 20:41:44 +00:00
Benjamin Peterson d79af0fc52 finish backporting binary literals and new octal literals docs 2008-10-30 22:44:18 +00:00
Benjamin Peterson b5f8208b49 backport bin() documentation 2008-10-30 22:39:25 +00:00
Benjamin Peterson b06b4c342f mention the version gettempdir() was added 2008-10-29 20:33:00 +00:00
Walter Dörwald 611e48c1bb Use the correct names of the stateless codec functions (Fixes issue 4178). 2008-10-23 13:11:39 +00:00
Benjamin Peterson cd29e9d9e1 and another typo... 2008-10-22 21:05:30 +00:00
Benjamin Peterson 92be53911d fix a few typos 2008-10-22 20:57:43 +00:00