Commit Graph

11154 Commits

Author SHA1 Message Date
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
Antoine Pitrou 6a2656094d Issue #5753: A new C API function, :cfunc:`PySys_SetArgvEx`, allows
embedders of the interpreter to set sys.argv without also modifying
sys.path.  This helps fix `CVE-2008-5983
<http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2008-5983>`_.
2010-05-21 17:12:38 +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
Tarek Ziadé 4fc2a008b8 upgraded distutils docs w.r.t. the manifest regeneration 2010-05-17 10:54: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 5f8aae0be3 Issue #8711: add paragraph titles to c-api/unicode.rst
(Python2 doesn't have PyUnicode_DecodeFSDefault*() functions)
2010-05-14 15:53:20 +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
Benjamin Peterson 8c72b4e931 rip out mention of types.ListType #8703 2010-05-13 21:14:10 +00:00
Andrew M. Kuchling f09bc66083 #8696: add documentation for logging.config.dictConfig (PEP 391) 2010-05-12 18:56:48 +00:00
Andrew M. Kuchling e551337f16 Grammar fix 2010-05-12 13:56:07 +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
Andrew M. Kuchling 68df234b73 Let's call this done 2010-05-12 00:40:47 +00:00
Andrew M. Kuchling 2702491687 Revision pass: lots of edits, typo fixes, rearrangements 2010-05-12 00:38:44 +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
Andrew M. Kuchling 264552a827 Link to unittest2 article 2010-05-10 15:03:35 +00:00
Andrew M. Kuchling 10595a64f3 Use title case 2010-05-10 14:20:12 +00:00
Andrew M. Kuchling 93c40d49f5 Markup fix; re-word a sentence 2010-05-10 14:18:27 +00:00
Benjamin Peterson 814a66f2d3 finish clause 2010-05-09 21:09:40 +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
Andrew M. Kuchling 0efe18ab0c Write summary of the 2.7 release; rewrite the future section some more;
mention PYTHONWARNINGS env. var; tweak some examples for readability.

And with this commit, the "What's New" is done... except for a
complete read-through to polish the text, and fixing any reported errors,
but those tasks can easily wait until after beta2.
2010-05-08 15:39:46 +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
Andrew M. Kuchling 304500cd10 Markup fixes 2010-05-08 13:29:46 +00:00
Andrew M. Kuchling 8e34386028 Add logging.dictConfig example; give up on writing a Ttk example 2010-05-08 13:28:03 +00:00
Andrew M. Kuchling badc709847 Get accents correct 2010-05-08 01:35:55 +00:00
Andrew M. Kuchling 85fffc368d Add two items 2010-05-08 01:15:26 +00:00
Andrew M. Kuchling d1e696b60f Re-word text 2010-05-07 11:30:47 +00:00
Antoine Pitrou d69e6ee656 Fix some markup and a class name. Also, wrap a long line. 2010-05-07 10:15:51 +00:00
Andrew M. Kuchling 02f7b990e1 Add a new section on the development plan; add an item 2010-05-07 01:45:14 +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 acab940c70 Change section title; point to unittest2 2010-05-06 17:27:57 +00:00
Andrew M. Kuchling 837a538db1 Add 2 items; record ideas for two initial sections; clarify wording 2010-05-06 17:21:59 +00:00
Andrew M. Kuchling e86b7fe37d Describe ElementTree 1.3; rearrange new-module sections; describe dict views as sets; small edits and items 2010-05-06 14:14:09 +00:00
Andrew M. Kuchling a14f2d1147 Use anonymous hyperlinks 2010-05-06 13:03:39 +00:00
Andrew M. Kuchling ca4856249d Add various items 2010-05-06 01:10:56 +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
Andrew M. Kuchling 04b99cc68d Add some more items; the urlparse change is added twice 2010-05-04 01:24:22 +00:00
Jesus Cea c3ce9e357d wbits negative was documented SEVEN years ago 2010-05-03 16:09:21 +00:00
Antoine Pitrou 5cace78c87 Fix attribution. Travis didn't do much and he did a bad work.
(yes, this is a sensitive subject, sorry)
2010-05-01 12:16:39 +00:00
Andrew M. Kuchling 9fbbd3b83d Describe memoryview 2010-05-01 12:06:51 +00:00
Andrew M. Kuchling 7de14ac034 Minor grammar fix 2010-05-01 12:05:52 +00:00
Andrew M. Kuchling d3b6022d0a Add various items 2010-05-01 01:19:16 +00:00
Andrew M. Kuchling c4ae73e5f7 Add item 2010-04-30 13:47:34 +00:00
Andrew M. Kuchling b3437c9f95 Minor grammar re-wording 2010-04-30 13:46:55 +00:00
Andrew M. Kuchling c121f130b5 Add various items; rearrange unittest section a bit 2010-04-30 01:33:40 +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
Benjamin Peterson b17b3c51e2 update pypy url 2010-04-29 03:30:59 +00:00
Benjamin Peterson fa0e7796dd update pypy description 2010-04-29 03:18:05 +00:00
Andrew M. Kuchling b2454b2ead Add various unittest items 2010-04-29 01:45:41 +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
Andrew M. Kuchling 15c82d2151 Add various items 2010-04-29 00:22:16 +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 ad709ee06b Add version changed note for -m tinkering with sys.argv[0] during the search process 2010-04-28 14:53:59 +00:00
Nick Coghlan c5e4485248 Issue 8202: when using the -m command line switch, sys.argv[0] is now '-m' instead of '-c' while searching for the module to be executed 2010-04-28 14:51:08 +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 0b093e068e #8522: use with statement instead of try-finally for file handling. 2010-04-25 10:17:27 +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
Georg Brandl e11d85c717 Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage. 2010-04-22 22:15:33 +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
R. David Murray 7794b5b52f Update link to Apple Publication Style guide. 2010-04-17 15:45:38 +00:00
Andrew M. Kuchling 85f928a5c9 Add various items 2010-04-15 01:42:27 +00:00
Andrew M. Kuchling 363dbccb2a Add various items; correct argparse output 2010-04-14 23:55:17 +00:00
Georg Brandl 9f5fd6092b Fix missing. 2010-04-14 21:46:45 +00:00
Georg Brandl c9a8a4aab8 #8370: fix module name in backported doc addition. 2010-04-14 21:36:49 +00:00
Georg Brandl 710a5dbc4a #5250: document __instancecheck__ and __subclasscheck__. I hope the part about the class/metaclass distinction is understandable. 2010-04-14 21:34:44 +00:00
Georg Brandl 4a589c3ede #8399: add note about Windows and O_BINARY. 2010-04-14 19:16:38 +00:00
Andrew M. Kuchling b6c1aeb486 Add some text 2010-04-14 14:28:31 +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
Andrew M. Kuchling f03641ace3 Add argparse example 2010-04-14 01:14:59 +00:00
Georg Brandl d0731072a9 Get rid of multi-row cells. 2010-04-13 06:43:54 +00:00
Andrew M. Kuchling ce6905245b Add an item; stray edit 2010-04-13 01:32:51 +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
Brian Curtin 4e20ab24cf Update the Windows FAQ's text about os.kill (#1220212). 2010-04-12 18:07:21 +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 4515f0de21 Add several items 2010-04-11 20:40:09 +00:00
Andrew M. Kuchling 6d7dfa231f Add two items 2010-04-11 12:49:37 +00:00
Andrew M. Kuchling 884d0a3c27 Two typo fixes 2010-04-11 12:48:08 +00:00
Raymond Hettinger f11363dcd3 Add descriptor howto to main documentation 2010-04-11 08:14:45 +00:00
Andrew M. Kuchling 7c2ab87568 Remove distutils section 2010-04-11 01:44:13 +00:00
Andrew M. Kuchling bfe8a84ce9 name correct 2010-04-11 01:40:49 +00:00
Andrew M. Kuchling ec6393f380 Add various items 2010-04-11 01:40:30 +00:00
Andrew M. Kuchling ca2413e2ad Punctuation fix 2010-04-11 01:40:06 +00:00
Andrew M. Kuchling fced90835c Two grammar fixes 2010-04-11 01:39:36 +00:00
Raymond Hettinger e694e00ee1 Add the sorting HOWTO to the main docs. 2010-04-11 00:01:23 +00:00
Georg Brandl 9352f1c64e #8346: update version. 2010-04-10 11:16:59 +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
Benjamin Peterson f3a8c6675f tell people to update python.man, too 2010-04-06 23:32:27 +00:00
Philip Jenvey aebbaeb962 #7301: add the environment variable $PYTHONWARNINGS to supplement the -W
command line option
patch from Brian Curtin
2010-04-06 23:24:45 +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