Commit Graph

1833 Commits

Author SHA1 Message Date
Antoine Pitrou de535cb615 Improve documentation for getaddrinfo() (part of #8857) 2010-05-31 17:01:01 +00:00
Stefan Krah 3d08d88459 Fix typo 2010-05-29 12:54:35 +00:00
Antoine Pitrou 9fe6199b4e Issue #8840: Make documentation for truncate() clearer 2010-05-29 12:06:13 +00:00
Benjamin Peterson 9b14ae8814 2to3 doesn't fix test_support #6583 2010-05-28 03:10:31 +00:00
R. David Murray 172e06e019 Issue 8818: urlparse/urlsplit keyword is 'scheme', not 'default_scheme'. 2010-05-25 15:32:06 +00:00
Georg Brandl f0757a2937 #8016: add the CP858 codec (approved by Benjamin). (Also add CP720 to the tests, it was missing there.) 2010-05-24 21:29:07 +00:00
Steven Bethard 74bd9cf7d0 argparse documentation updates (including updates to optparse and getopt documentation that were promised in the PEP) 2010-05-24 02:38:00 +00:00
Georg Brandl 151973e1c8 #1436346: make it more obvious that timetuple[7] is yday. 2010-05-23 21:29:29 +00:00
Georg Brandl f93ce0c1f5 #8785: less confusing description of regex.find*. 2010-05-22 08:17:23 +00:00
Georg Brandl fa0fdb89e9 #8709: mention Windows support for os.devnull. 2010-05-21 22:03:29 +00:00
Georg Brandl 042d6a4f75 Correct info for Semaphore.acquire() semantics under OSX. 2010-05-21 21:47:05 +00:00
Georg Brandl dd59f1bf92 #8707: remove duplicate paragraph part. 2010-05-21 21:30:47 +00:00
Georg Brandl 233eb54051 Add missing parameter in SimpleXMLRPCServer signature. 2010-05-21 20:58:12 +00:00
Georg Brandl da69add804 typo 2010-05-21 20:52:46 +00:00
Georg Brandl 16fd5cdfeb #8783: replace link to now dead hash collision FAQ. 2010-05-21 20:24:45 +00:00
Vinay Sajip c76defc118 Updated logging documentation with more dictConfig information. 2010-05-21 17:41:34 +00:00
Benjamin Peterson a85bd06a82 fix extra 't' #8778 2010-05-20 22:23:37 +00:00
Stefan Krah 4a769059be Fix typo. 2010-05-19 15:59:40 +00:00
Ezio Melotti 019551fa1b Fix typo in argparse doc. 2010-05-19 00:32:52 +00:00
Vinay Sajip a38cd52e96 Fixed minor typo in ReST markup. 2010-05-18 08:16:27 +00:00
Senthil Kumaran 71a632433f Fix minor typo. 2010-05-18 03:20:43 +00:00
Andrew M. Kuchling 1b553473ed Add cross-reference to later section 2010-05-16 23:31:16 +00:00
Antoine Pitrou 308c2af9a4 Document that SSL v2 is insecure. 2010-05-16 14:16:56 +00:00
Victor Stinner 8ded477916 Doc: replace PEP xxx by :pep:`xxx` to create a link on the PEP 2010-05-14 14:20:07 +00:00
Andrew M. Kuchling f09bc66083 #8696: add documentation for logging.config.dictConfig (PEP 391) 2010-05-12 18:56:48 +00:00
Fred Drake 62bebdf49f - clarify Attr.name comment on the presence of colons in namespace mode
- document Attr.value
- wrap some long lines
2010-05-12 02:24:50 +00:00
Fred Drake 5840469067 fix error introduced in previous commit, and the adjacent additional typo 2010-05-12 01:22:03 +00:00
Brian Curtin b9bf97132d #8575 - Update and reorganize some _winreg contents.
I've removed the hopeful note about a future higher-level module since
it's been in there for quite a long time and nothing of the sort has
come up. There are a few places where markup was added to cross-reference
other sections, and many of the external links have been removed and now
point to newly created sections containing previously undocumented
information.

The Value Types section was created and it's contents were taken from
a function-specific area, since it applies to more than just that
function. It fits in better with the other newly documented constants.
2010-05-11 19:13:13 +00:00
Fred Drake 8b37dd1613 fix typo 2010-05-11 18:12:27 +00:00
Andrew M. Kuchling 5d864c847e Fix typo 2010-05-10 23:13:41 +00:00
Georg Brandl 6487952a46 Fix typo. 2010-05-10 21:51:33 +00:00
Georg Brandl 6f635f41f2 Consolidate deprecation messages. 2010-05-10 21:50:57 +00:00
Georg Brandl 0ddc30b7f9 Fix reference direction. 2010-05-10 21:46:50 +00:00
Georg Brandl c630195784 #8642: fix wrong function name. 2010-05-10 21:02:51 +00:00
Florent Xicluna 638b869004 Add a link on maketrans(). 2010-05-10 19:59:22 +00:00
Eric Smith 368ede83d9 Issue 8671: Whitespace fix. 2010-05-09 14:04:59 +00:00
Mark Dickinson 7000e9e01b Issue #8644: Improve accuracy of timedelta.total_seconds method.
(Backport of r80979 to py3k.)  Thanks Alexander Belopolsky.
2010-05-09 09:30:06 +00:00
Michael Foord 959c16d7a4 Updating documentation and adding docstrings to unittest.TestCase.assertRegexpMatches and assertNotRegexpMatches. Issue 8038. 2010-05-08 16:40:52 +00:00
Michael Foord 8851b71c6f Documenting test discovery from package name and potential problems with test discovery importing tests from the wrong location. Issue 7780 and issue 8547. 2010-05-08 15:09:37 +00:00
Benjamin Peterson 328e3775df ensure that availability information is on its own line at the end of the function docs 2010-05-06 22:49:28 +00:00
Benjamin Peterson 7aaef849f9 Availability gets its own line 2010-05-06 22:33:46 +00:00
Andrew M. Kuchling a14f2d1147 Use anonymous hyperlinks 2010-05-06 13:03:39 +00:00
Andrew M. Kuchling 4758183f0a Reword paragraph; fix filename, which should be pyconfig.h 2010-05-06 01:09:47 +00:00
Mark Dickinson 9319548e56 Issue 8628: fix incorrect documentation for numbers.Complex.imag. 2010-05-05 21:52:39 +00:00
Ronald Oussoren 9545a23c7f In a number of places code still revers
to "sys.platform == 'mac'" and that is
dead code because it refers to a platform
that is no longer supported (and hasn't been
supported for several releases).

Fixes issue #7908 for the trunk.
2010-05-05 19:09:31 +00:00
Jesus Cea c3ce9e357d wbits negative was documented SEVEN years ago 2010-05-03 16:09:21 +00:00
Andrew M. Kuchling 7de14ac034 Minor grammar fix 2010-05-01 12:05:52 +00:00
Andrew M. Kuchling 603831825b Markup fix; clarify by adding 'in that order' 2010-04-30 01:32:47 +00:00
Andrew M. Kuchling 545336673e Fix typos 2010-04-30 01:02:15 +00:00
Andrew M. Kuchling 3ded421fd5 Reword paragraph to make its meaning clearer.
Antoine Pitrou: is my version of the paragraph still correct?

R. David Murray: is this more understandable than the previous version?
2010-04-30 00:52:31 +00:00
Giampaolo Rodolà a01f6892d6 Fixes issue 8543 (asynchat documentation issues) 2010-04-29 20:31:17 +00:00
Senthil Kumaran f62b50f306 Fixing the Broken links of mechanize library. 2010-04-29 19:46:08 +00:00
Ezio Melotti ab9149dc8a Group the Windows entries in getfilesystemencoding doc, move the win 9x one at the bottom of the list and fix some markup. 2010-04-29 16:07:20 +00:00
Andrew M. Kuchling fb759a25f2 Fix doubled 'the'.
Markup fixes to use :exc:, :option: in a few places.
  (Glitch: unittest.main's -c ends up a link to the Python
  interpreter's -c option.  Should we skip using :option: for that
  switch, or disable the auto-linking somehow?)
2010-04-29 01:44:30 +00:00
Antoine Pitrou 689405ee14 Clarify and fix the documentation for IOBase.close() 2010-04-28 19:57:33 +00:00
Antoine Pitrou ece349e517 State clearly that truncate() doesn't move the file position,
and remove a duplicate of its specification.
2010-04-28 19:53:35 +00:00
Senthil Kumaran ed9204346e Fixed Issue6312 - httplib fails with HEAD requests to pages with "transfer-encoding: chunked" 2010-04-28 17:20:43 +00:00
Nick Coghlan dfb45dfd04 Issue 7490: make IGNORE_EXCEPTION_DETAIL also ignore details of the module containing the exception under test (original patch by Lennart Regebro) 2010-04-28 14:29:06 +00:00
Benjamin Peterson eef5c35c14 make slice notation in (r)find docs consistent 2010-04-27 22:56:31 +00:00
Benjamin Peterson a9bd6d5ea7 reject None as the buffering argument like the C implementation does #8546 2010-04-27 21:01:54 +00:00
Michael Foord 47b5440f43 Adding versionadded to various new unittest functions in documentation 2010-04-26 23:36:47 +00:00
Michael Foord 5c322ece96 Adding unittest.removeHandler function / decorator for removing the signal.SIGINT signal handler. With tests and docs. 2010-04-25 19:02:46 +00:00
Georg Brandl adbcf1f4a8 Patch from Tim Hatch: Make socket setblocking <-> settimeout examples symmetric. 2010-04-25 10:57:15 +00:00
Georg Brandl 1e518258c9 Fix code example to have valid syntax so that it can be highlighted. 2010-04-25 10:56:41 +00:00
Georg Brandl bb091e733c Patch from Tim Hatch: Minor spelling changes to _winreg docs. 2010-04-25 10:55:58 +00:00
Georg Brandl a3f1e4cde7 Patch from Tim Hatch: Remove reference to winreg being the fabled high-level registry interface. 2010-04-25 10:55:16 +00:00
Georg Brandl 9bfb78d698 Patch from Tim Hatch: Better cross-referencing in socket and winreg docs. 2010-04-25 10:54:42 +00:00
Georg Brandl 1f62087649 Remove LaTeXy index entry syntax. 2010-04-25 10:29:17 +00:00
Georg Brandl 404bd7f473 #8528: fix typo. 2010-04-25 10:16:00 +00:00
Brian Curtin 5fa9fb4062 Fix #5774. Some _winreg functions are documented as taking kwargs but don't. 2010-04-24 17:10:22 +00:00
Georg Brandl f8bff488bd Markup fixes. 2010-04-24 08:56:58 +00:00
Sean Reifscheider f6ce3cb84e issue8451: Making syslog module use sys.argv[0] for "ident". 2010-04-23 08:31:55 +00:00
Senthil Kumaran 398246169c Changed tests to only urlparse one, which was enough, addressed Ezio's comment
on Invalid url check statement and versionchanged string in docs.
2010-04-22 12:10:13 +00:00
Senthil Kumaran 0a36181953 Updated the RFCs list in the See Also section of urlparse.rst 2010-04-22 05:48:35 +00:00
Tarek Ziadé e593fad81b removed ztar support in shutil.make_archive 2010-04-20 21:09:06 +00:00
Ezio Melotti 8c09ebcf0c #8472: fix wrong function name in functions.rst: itertools.filterfalse -> itertools.ifilterfalse 2010-04-20 16:49:48 +00:00
Brian Curtin 1f8dd363b7 Add version info for os.kill and signal changes from #1220212. 2010-04-20 15:23:18 +00:00
Tarek Ziadé 8a12f940fe Fixed #8463: added missing reference to bztar in shutil's documentation. 2010-04-19 21:28:21 +00:00
Antoine Pitrou 0a6373c1a9 Issue #8322: Add a *ciphers* argument to SSL sockets, so as to change the
available cipher list.  Helps fix test_ssl with OpenSSL 1.0.0.
2010-04-17 17:10:38 +00:00
Georg Brandl c9a8a4aab8 #8370: fix module name in backported doc addition. 2010-04-14 21:36:49 +00:00
Georg Brandl 4a589c3ede #8399: add note about Windows and O_BINARY. 2010-04-14 19:16:38 +00:00
Georg Brandl 6c50efe76b Add an x-ref to where the O_ constants are documented and move the SEEK_ constants after lseek(). 2010-04-14 13:50:31 +00:00
Raymond Hettinger 44340e6d78 Add usage notes for collections.Counter(). 2010-04-12 21:12:06 +00:00
Mark Dickinson 78ab583d63 More struct doc tweaks. 2010-04-12 20:38:36 +00:00
Mark Dickinson b633f10f81 Rewrap some long lines in struct module doc source. 2010-04-12 19:46:20 +00:00
Mark Dickinson bbacb838c9 Issue #7355: Various improvements to struct module documentation.
- note early on that the result of struct.pack includes padding
   bytes by default

 - add examples showing how order of struct fields can affect size
   (due to padding)

 - better headers and references; introduction to format strings

 - integrate packing notes into table

Many thanks to Meador Inge for the patch.
2010-04-12 19:25:32 +00:00
R. David Murray 1a14d3d169 Issue #7585: use tab between components in unified and context diff headers.
Instead of spaces between the filename and date (or whatever the string
is that follows the filename, if any) use tabs.  This is what the unix
'diff' command does, for example, and difflib was intended to follow
the 'standard' way of doing diffs.  This improves compatibility with
patch tools.  The docs and examples are also changed to recommended that
the date format used be the ISO 8601 format, which is what modern diff
tools emit by default.

Patch by Anatoly Techtonik.
2010-04-12 16:35:19 +00:00
Barry Warsaw fa900d47b8 typo 2010-04-12 14:40:49 +00:00
Andrew M. Kuchling 884d0a3c27 Two typo fixes 2010-04-11 12:48:08 +00:00
Andrew M. Kuchling ca2413e2ad Punctuation fix 2010-04-11 01:40:06 +00:00
Georg Brandl 90aae551b1 #8360: skipTest was added in 2.7. 2010-04-10 11:15:24 +00:00
Raymond Hettinger a1d61d0495 Fixup new itertools recipes. 2010-04-10 07:01:32 +00:00
Michael Foord efc2f497fd Correction of unittest documentation typos and omissions 2010-04-08 04:33:20 +00:00
Vinay Sajip 497256ba18 Issue #8331: logging: fixed some grammatical errors in documentation. 2010-04-07 09:40:52 +00:00
Vinay Sajip ccd8bc8a83 Issue #8327: logging: Clarification of propagation functionality in documentation. 2010-04-06 22:32:37 +00:00
Mark Dickinson ad971d62ee More NaN consistency doc fixes. 2010-04-06 22:18:23 +00:00
Mark Dickinson e07acb5f15 Use consistent spelling for nans (thanks Georg for noticing). 2010-04-06 22:10:55 +00:00
Mark Dickinson 99e73f9145 Issue #7947: Clarify math module behaviour for IEEE 754 special cases, along
with a number of additional minor edits and typo corrections.
2010-04-06 19:50:03 +00:00
Georg Brandl abe448c49b #8320: document return value of recv_into(). 2010-04-06 08:18:15 +00:00
Antoine Pitrou f9de534c21 Issue #8321: Give access to OpenSSL version numbers from the `ssl` module,
using the new attributes `ssl.OPENSSL_VERSION`, `ssl.OPENSSL_VERSION_INFO`
and `ssl.OPENSSL_VERSION_NUMBER`.
2010-04-05 21:35:07 +00:00
Michael Foord d341ec82c7 Further documentation fix for unittest.rst 2010-04-05 10:30:14 +00:00
Michael Foord c5ff3f6ff0 Furterh documentation fix for unittest.rst 2010-04-05 10:28:27 +00:00
Michael Foord 3165503b4a Documentation fixes for unittest 2010-04-05 10:26:26 +00:00
Ezio Melotti 9ccc58113e Fix markup errors. 2010-04-05 08:16:41 +00:00
Ezio Melotti 01fa86a0bd Fix markup, punctuation and whitespaces in _winreg.rst. 2010-04-05 08:02:54 +00:00
Michael Foord 554303530c Document signal handling functions in unittest.rst 2010-04-05 00:39:50 +00:00
Michael Foord ddb20df018 Adding documentation for new unittest.main() parameters 2010-04-04 23:28:44 +00:00
Ezio Melotti 6f65d2dd1b Fix markup in decimal.rst. 2010-04-04 23:21:53 +00:00
Michael Foord 09e2980c15 unittest documentation formatting changes 2010-04-04 22:41:54 +00:00
Mark Dickinson b1affc517f Add versionchanged entry for Decimal(float) construction.
Also add an example of constructing a Decimal directly from a float,
update the quickstart tutorial, and tweak another couple of
sentences.
2010-04-04 22:09:21 +00:00
Raymond Hettinger bb006cf26c Add tests for cmp_to_key.
Adopt PEP 8 compliant function name.
Factor-out existing uses cmp_to_key.
Update documentation to use internal pointers instead of external resource.
2010-04-04 21:45:01 +00:00
Raymond Hettinger a551f31d48 Add functools.CmpToKey() 2010-04-04 18:34:45 +00:00
Raymond Hettinger 0d57caa267 Documentation nit 2010-04-04 07:33:46 +00:00
Ezio Melotti 4edfe96381 Revert 79733 - Counter is new in 2.7, the versionadded is not necessary - and fix a typo. 2010-04-04 06:50:58 +00:00
Ezio Melotti 0cee3794c7 Add a versionadded to Counter.subtract() doc. 2010-04-04 06:41:27 +00:00
Raymond Hettinger 20ae90d887 Issue 5479: Add functools.total_ordering class decorator. 2010-04-04 01:24:59 +00:00
Antoine Pitrou 945d4ccdd9 Fix wording / typography, and a slightly misleading statement
(memoryviews don't support complex structures right now)
2010-04-03 21:22:38 +00:00
Raymond Hettinger 5f516edd77 Add count() method to collections.deque(). 2010-04-03 18:10:37 +00:00
Michael Foord ba097ec1be Documenting new features in unittest 2010-04-03 17:03:11 +00:00
Mark Dickinson 4846a8e828 Issue #8300: Let struct.pack use __index__ to convert and pack non-integers.
Based on a patch by Meador Inge.
2010-04-03 14:05:10 +00:00
Raymond Hettinger 34c35b2788 Add subtract() method to collections.Counter() objects. 2010-04-03 10:22:00 +00:00
Brian Curtin e5aa886b44 Implement #1220212. Add os.kill support for Windows.
os.kill takes one of two newly added signals, CTRL_C_EVENT and
CTRL_BREAK_EVENT, or any integer value. The events are a special case
which work with subprocess console applications which implement a
special console control handler. Any other value but those two will
cause os.kill to use TerminateProcess, outright killing the process.

This change adds win_console_handler.py, which is a script to implement
SetConsoleCtrlHandler and applicable handler function, using ctypes.

subprocess also gets another attribute which is a necessary flag to
creationflags in Popen in order to send the CTRL events.
2010-04-02 23:26:06 +00:00
Mark Dickinson 7c63eee485 Issue #8294: Allow float and Decimal arguments in Fraction constructor. 2010-04-02 22:27:36 +00:00
Brian Curtin e33fa887d3 Implement #7347. Add CreateKeyEx, DeleteKeyEx, and update _winreg tests.
*ReflectionKey functions used to not be documented or tested, but they are
now sufficiently documented and tested on platforms where they apply.
Additionally, fixed a bug in QueryReflectionKey which was returning an
incorrect value.

All tests pass from XP through Windows 7, on 32 and 64-bit platforms.
2010-04-02 21:18:14 +00:00
Raymond Hettinger ed171abd93 Issue 8257: Decimal constructor to accept float. 2010-04-02 18:39:24 +00:00
Andrew M. Kuchling dc36d7cf85 #6647: add note to two examples 2010-04-02 17:54:26 +00:00
Andrew M. Kuchling d886290464 #6647: document that catch_warnings is not thread-safe 2010-04-02 17:48:23 +00:00
Georg Brandl d3bab6aba9 Remove col-spanning cells in logging docs. 2010-04-02 09:03:18 +00:00
Mark Dickinson 99d8096c17 Issue #2531: Make float-to-decimal comparisons return correct results.
Float to decimal comparison operations now return a result based on
the numeric values of the operands.  Decimal.__hash__ has also been
fixed so that Decimal and float values that compare equal have equal
hash value.
2010-04-02 08:53:22 +00:00
Georg Brandl 49b9192b12 #2768: add a note on how to get a file descriptor. 2010-04-02 08:39:09 +00:00
Raymond Hettinger f28dd0d1bf Cleanup itertools recipes 2010-04-02 06:23:12 +00:00
Raymond Hettinger 4bfd3bda2e Add and update itertools recipes. 2010-04-02 02:44:31 +00:00
Raymond Hettinger f54c268326 Document link to Sorting HowTo 2010-04-01 07:54:16 +00:00
R. David Murray 6c9fc4cf2b A couple small grammar fixes in test.rst, and rewrite the
check_warnings docs to be clearer.
2010-04-01 01:28:39 +00:00
Benjamin Peterson 7e213255ce add inspect.getcallargs, which binds function arguments like a normal call #3135
Patch by George Sakkis
2010-03-30 17:58:13 +00:00
Michael Foord e6410c536c Backport of weakref.WeakSet and tests from Python 3. 2010-03-29 20:04:23 +00:00
Raymond Hettinger b8d688cd7c Update itertools recipe for consume(). 2010-03-28 18:25:01 +00:00
Raymond Hettinger d282b931a3 Add a note on optimizing the itertools recipes for production. 2010-03-28 18:08:15 +00:00
Raymond Hettinger 5b027f87b5 Update itertools recipes. 2010-03-28 18:02:41 +00:00
Brian Curtin fbe519975b Fix #6538. Markup RegexObject and MatchObject as classes. Patch by Ryan Arana. 2010-03-25 23:48:54 +00:00
Vinay Sajip 66d19e2a0c logging: Updated SysLogHandler documentation. 2010-03-24 17:36:35 +00:00
Vinay Sajip a3c39c0f72 logging: Documentation tweak. 2010-03-24 15:10:40 +00:00
Vinay Sajip b0623d64a8 logging: Added LOG_FTP for SysLogHandler and updated documentation. 2010-03-24 14:31:21 +00:00
Senthil Kumaran 67b4e187e1 Fixed Issue8209 - OptionParser keyword arg 'epilog' not mentioned in the docs 2010-03-23 08:46:31 +00:00
Ezio Melotti 0d0b80bc3e Link specifically to the UCD version 5.2.0. 2010-03-23 00:38:12 +00:00
Ezio Melotti 88b6f8bada Remove link to objects.rst (gone in r79179). 2010-03-23 00:25:19 +00:00
Ezio Melotti ae735a763e Update the version number of the Unicode Database in a few more places. 2010-03-22 23:07:32 +00:00
Vinay Sajip 804899b4ab logging: Added getChild utility method to Logger and added isEnabledFor method to LoggerAdapter. 2010-03-22 15:29:01 +00:00
Georg Brandl aa89f8d04c Remove leftover word. 2010-03-21 11:50:58 +00:00
Georg Brandl ce00cf2ce7 Update text for newest US DST regulation. The sample file already has the calculation right. 2010-03-21 09:58:36 +00:00