Commit Graph

20257 Commits

Author SHA1 Message Date
Raymond Hettinger bd04919014 Issue #19934: Document *None* as an acceptable input to Counter.most_common([n]) 2015-05-13 02:50:57 -07:00
Benjamin Peterson b9b0a580f2 use imperative 2015-05-12 19:15:53 -04:00
Raymond Hettinger 632d692e29 Issue #24161: Document that PyIter_Check() returns false positives for old-style instances. 2015-05-11 10:22:20 -07:00
Benjamin Peterson 69af580131 update example, since python.org is HTTPS-only now (closes #24118) 2015-05-03 13:00:21 -04:00
R David Murray 10324f88a8 #24108: Update fnmatch.translate example to show correct output.
Patch by Merlijn van Deen.
2015-05-02 15:09:22 -04:00
R David Murray 11d041a045 #24081: Remove obsolete caveat from import docs.
Per Eric Snow's research, this changed in Python 2.4 in changeset 331e60d8ce,
but these docs were not updated.
2015-05-02 15:02:30 -04:00
Vinay Sajip 68099ae7e0 Issue #24060: Made logging.Formatter documentation a little clearer. 2015-05-02 09:42:24 +01:00
Berker Peksag 31200ff81b Issue #23356: Simplify convert_arg_line_to_args example.
Patch by py.user.
2015-04-26 12:12:45 +03:00
Benjamin Peterson cf0d31c8ba fix relative link (closes #24057) 2015-04-25 14:15:16 -04:00
Benjamin Peterson 2c6ca8adb3 recommend requests library (closes #23989)
Patch by Van Lindberg.
2015-04-20 18:20:27 -04:00
Vinay Sajip 1b4aa45441 Issue #23536: Clarified scope of fileConfig()'s API. 2015-04-18 13:05:19 +01:00
Charles-François Natali 6d12c80c91 Fix PyGILState_GetThisThreadState() prototype in the API documentation. 2015-04-15 19:30:38 +01:00
Zachary Ware e093f11f4b Issue #23730: Document the return value of ZipFile.extract
Patch by Stéphane Wirtel.
2015-04-13 16:40:49 -05:00
Zachary Ware b9298a4fbb Issue #17202: Add .bat to .hgeol to force them to CRLF.
Using LF can a script to fail if it tries to use a label that is
split across 512 byte blocks.  Who knows why.
2015-04-13 11:54:11 -05:00
Benjamin Peterson 721c86ef36 use imperative 2015-04-11 07:42:42 -04:00
Benjamin Peterson af80ce3f82 highlight is now highlighted (closes #23909) 2015-04-10 18:40:21 -04:00
Berker Peksag 928b3fff8a Issue #23400: Add notes about the sem_open support of the host OS to
"Pipes and Queues" and "Synchronization between processes" subsections.

Patch by Davin Potts.
2015-04-08 18:12:53 +03:00
Benjamin Peterson ce29e87e6f actually ssl3 is just completely broken 2015-04-08 11:11:00 -04:00
Raymond Hettinger 2baaba8a95 Issue #23729: Improve docs for ElementTree namespace parsing 2015-03-30 20:46:54 -07:00
Ezio Melotti 1afb9da747 #23512: list non-essential built-in functions after the table. Patch by Carlo Beccarini. 2015-03-24 13:44:58 +02:00
Ezio Melotti bc1fda39ae #11468: improve unittest basic example. Initial patch by Florian Preinstorfer. 2015-03-24 12:42:41 +02:00
Raymond Hettinger 510a6e9247 Issue 23729: Document ElementTree namespace handling and fix an omission in the XPATH predicate table. 2015-03-22 15:31:28 -07:00
R David Murray b4b000f002 #23539: Set Content-Length to 0 for PUT, POST, and PATCH if body is None.
Some http servers will reject PUT, POST, and PATCH requests if they
do not have a Content-Length header.

Patch by James Rutherford.
2015-03-22 15:15:44 -04:00
Benjamin Peterson 29368584d2 clarify behavior of shutil.move when destination exists (closes #22933)
Patch by Mike Short.
2015-03-22 10:11:54 -04:00
Benjamin Peterson 5151838132 versionchanged for rc4 removal (closes #23679) 2015-03-16 12:43:38 -05:00
Eli Bendersky 9872ad46d5 Issue #23549: Clarify confusion in heapq doc - accessing the mininmal element
The current documentation only mentions heap[0] as the smallest element in the
beginning, and not in any of the methods' docs. There's no method to access the
minimal element without popping it, and the documentation of nsmallest is
confusing because it may suggest that min() is the way to go for n==1.
default
2015-03-14 20:20:36 -07:00
Serhiy Storchaka 251aede2f2 Fix minor docs markup errors. 2015-03-14 21:32:41 +02:00
Benjamin Peterson dbbc07c2ec the default is sys.maxsize not sys.maxint (closes #23645) 2015-03-13 14:32:31 -05:00
Ned Deily 0acf4ad786 Issue #23617: Correct plurals typo noted by Kentrell Johnson. 2015-03-09 01:54:25 -07:00
Benjamin Peterson 81bec811b3 replace Amazon links in the documentation (closes #23579)
Patch by Sayan Chowdhury.
2015-03-07 09:34:16 -05:00
Benjamin Peterson 72ef961059 expose X509_V_FLAG_TRUSTED_FIRST 2015-03-04 22:49:41 -05:00
Benjamin Peterson b198ad9a3c wrap everything at 80 chars 2015-03-02 09:34:31 -05:00
Ned Deily 0e4da40e58 Issue #23499: Fix grammar error noticed by SilentGhost 2015-02-22 16:08:23 -08:00
Serhiy Storchaka 4809d1fccd Issues #814253, #9179: Warnings now are raised when group references and
conditional group references are used in lookbehind assertions in regular
expressions.
2015-02-21 12:08:36 +02:00
Zachary Ware bbdad5442b Fix typo pointed out on docs@ by Yaniv Sayeh 2015-02-19 22:28:36 -06:00
Ned Deily e0944c94e0 Fix missing :ref: for idle in doc build. 2015-02-06 15:41:27 +11:00
Benjamin Peterson ad5ddf79c3 remove parenthesis from print statement (closes #23396) 2015-02-04 22:06:55 -05:00
Stefan Krah 1c9bf63a15 Preserve critical whitespace in Doc/*. 2015-02-01 19:49:38 +01:00
Stefan Krah 3f1ef5b756 Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsets
are required.
2015-02-01 19:40:50 +01:00
Vinay Sajip caaaa1413a Added a cookbook entry on logging audible messages. 2015-02-01 15:14:03 +00:00
Vinay Sajip 9e74fc3ee2 Added a logging cookbook entry on customized exception formatting. 2015-01-28 07:29:13 +00:00
Serhiy Storchaka c328d11ef1 Issue #14099: Backout changeset c2c4cde55f6f (except adapted tests). 2015-01-26 13:45:04 +02:00
R David Murray 9a6d32e78c #23251: Reflow paragraph. 2015-01-25 15:48:47 -05:00
R David Murray f8fe12a5a6 #23251: note that time.sleep affects the current thread only.
This is parallel to the language used in the unix man page.
2015-01-25 15:48:26 -05:00
Benjamin Peterson aa7075845c prefer server alpn ordering over the client's 2015-01-23 17:30:26 -05:00
Benjamin Peterson 65aa261eba fix versionchanged 2015-01-23 16:47:52 -05:00
Benjamin Peterson b10bfbe036 pep 466 backport of alpn (#20188) 2015-01-23 16:35:37 -05:00
Vinay Sajip 5e3b2dfef4 Issue #23305: clarified RotatingFileHandler documentation. 2015-01-23 21:18:02 +00:00
Berker Peksag 1b6e5381c3 Issue #22317: Document the action parameter in ArgumentParser.add_subparsers() docs.
Patch by Mike Short.
2015-01-20 06:55:51 +02:00
Serhiy Storchaka e8c9e14af9 Issue #23181: More "codepoint" -> "code point". 2015-01-18 11:42:50 +02:00
Ned Deily b5daa3d6db Issue #23180: Rename IDLE "Windows" menu item to "Window".
Patch by Al Sweigart.
2015-01-17 21:03:41 -08:00
Georg Brandl 7ff0360223 Closes #23244: fix typo. Thanks Mayank Tripathi for the patch. 2015-01-15 08:16:01 +01:00
Ethan Furman 3700cc3ad6 Issue20467: clarify __init__'s role 2015-01-14 22:02:10 -08:00
Georg Brandl a44ec3ff4c Closes #23181: codepoint -> code point 2015-01-14 08:26:30 +01:00
Benjamin Peterson 07f90476b9 fix instances of consecutive articles (closes #23221)
Patch by Karan Goel.
2015-01-13 09:17:24 -05:00
Antoine Pitrou a8efb6b080 Issue #22952: improve multiprocessing doc introduction and defer notes until appropriate.
Patch by Davin Potts.
2015-01-11 15:09:27 +01:00
Mark Dickinson a024f80a71 Issue #21902: Replace incorrect 'hyperbolic arc sine' (etc.) with 'inverse hyperbolic sine' (etc.). Remove meaningless reference to radians. 2015-01-11 13:03:06 +00:00
Berker Peksag 96556a7b1f Silence a Sphinx warning in ftplib.rst.
ftplib.rst:61: WARNING: Block quote ends without a blank line; unexpect
ed unindent.
2015-01-06 18:36:02 +02:00
Berker Peksag 80154584a6 Fix a markup error in the argparse documentation.
Reported by Jason Sachs on docs@.
2015-01-06 18:29:04 +02:00
Victor Stinner 7c90667f74 Issue #21356: Make ssl.RAND_egd() optional to support LibreSSL. The
availability of the function is checked during the compilation. Patch written
by Bernard Spil.
2015-01-06 13:53:37 +01:00
Vinay Sajip 6fcb9a5152 Clarified documentation for logging exception function/method. 2015-01-06 11:10:12 +00:00
Benjamin Peterson 0258c5de8b emphasize that cffi is better than extension modules for portability 2015-01-05 14:38:46 -06:00
Benjamin Peterson 7b4b28469b allow a SSLContext to be given to ftplib.FTP_TLS 2015-01-04 15:36:31 -06:00
Benjamin Peterson 9fe67ceebf make SSLv23 the default version in ftplib (closes #23111) 2015-01-04 10:20:16 -06:00
Ned Deily b09ec90e9b Add missing URL link to Modernize docs. 2015-01-03 00:45:25 -08:00
Benjamin Peterson dd87637d04 update for copyright for 2015 2014-12-31 18:09:36 -06:00
Berker Peksag 87d415fa5c Issue #23125: Update nose project page link.
Reported by Damien Marié.
2014-12-28 18:51:25 +02:00
Benjamin Peterson cb36d247a7 improve incorrect French (#23109)
Following suggestions from Clément.
2014-12-24 13:58:05 -06:00
Berker Peksag d4f5c1436b Issue #23070: Fix a comment in the tutorial.
"Python" has 6 characters, not 7.

Reported by Ross Burnett.
2014-12-17 14:59:33 +02:00
Berker Peksag 0bf02c8df4 Issue #23047: Fix typo in pyporting.rst.
Patch by Chaitanya agrawal.
2014-12-13 15:51:18 +02:00
Brett Cannon fcf094c950 Backport of porting HOWTO 2014-12-12 15:15:49 -05:00
Benjamin Peterson df611a97f0 remove reference to dead irc channel (closes #23038) 2014-12-12 09:56:33 -05:00
Raymond Hettinger e4efc3d913 Issue 23005: Fix typos 2014-12-11 23:55:54 -08:00
Terry Jan Reedy f0f09b9470 Issue #23006: Improve the documentation and indexing of dict.__missing__.
Add an entry in the language datamodel special methods section.
Revise and index its discussion in the stdtypes mapping/dict section.
Backport the code example from 3.4.
2014-12-10 18:38:07 -05:00
Benjamin Peterson 402bd79817 fix path to patchlevel.py 2014-12-10 11:04:17 -05:00
Ned Deily 62a8660267 Issue #17128: Use private version of OpenSSL for 2.7.9 OS X 10.5+ installer.
Among other issues, the Apple-supplied 0.9.7 libs for the 10.5 ABI cannot
verify newer SHA-256 certs as now used by python.org services.  Document
in the installer ReadMe some of the certificate management issues that
users now need to be more concerned with due to PEP 476's enabling cert
verification by default.  For now, continue to use the Apple-supplied
0.9.8 libs for the 10.6+ installer since they use Apple private APIs to
verify certificates using the system- and user-managed CA keychain stores.
2014-12-09 23:45:13 -08:00
Berker Peksag 3e1c8237e8 Issue #12602: Add missing cross-references to runpy and using/cmdline docs.
Patch by Éric Araujo.
2014-12-10 02:07:08 +02:00
Benjamin Peterson a50afa386c Merge 2.7.9 release branch 2014-12-07 14:25:59 -05:00
Benjamin Peterson 73d5031054 remove mention of check_hostname parameter 2014-12-07 14:25:38 -05:00
Benjamin Peterson 204a0eca5a merge 2.7.9 release branch 2014-12-07 13:41:52 -05:00
Benjamin Peterson 227f6e0dc5 remove HTTPSConnection's check_hostname parameter (#22959) 2014-12-07 13:41:26 -05:00
Benjamin Peterson 542125e614 merge 2.7.9 release branch 2014-12-06 11:36:48 -05:00
Benjamin Peterson fd0c92fe07 note that sslv3 may not be available 2014-12-06 11:36:32 -05:00
Terry Jan Reedy bafef5ade3 Edit Menus section of Idle doc. Make menu entries match current Idle in order
and case.  Edit some of the explanatory sentences and end all with a period.
2014-12-05 02:42:54 -05:00
Terry Jan Reedy 9e466cf122 Issue #3068: Document the new Configure Extensions dialog and menu entry. 2014-12-04 01:22:41 -05:00
Terry Jan Reedy eb40589324 Issue #16893: Update 2.7 version of Idle doc to match 3.4 doc as of the just
committed 6db65ff985b6.
2014-12-04 00:55:46 -05:00
Antoine Pitrou bf9eb35f96 Fix #22987: update the compatibility matrix for a SSLv23 client. 2014-12-03 20:00:56 +01:00
Serhiy Storchaka 45aa771fe9 Issue #14099: ZipFile.open() no longer reopen the underlying file. Objects
returned by ZipFile.open() can now operate independently of the ZipFile even
if the ZipFile was created by passing in a file-like object as the first
argument to the constructor.
2014-12-03 09:11:12 +02:00
Benjamin Peterson 5a608c2e8b merge 2.7.9 release branch 2014-11-29 22:57:15 -05:00
Benjamin Peterson efa3cf84d2 add context parameter to xmlrpclib.ServerProxy (#22960)
Patch from Alex Gaynor.
2014-11-29 22:55:35 -05:00
Serhiy Storchaka 2c1f37667d Issue #21514: The documentation of the json module now refers to new JSON RFC
7159 instead of obsoleted RFC 4627.
2014-11-27 19:41:34 +02:00
Zachary Ware 6ac2b4db94 pydoc: Add a note about setting PAGER to affect console output pagination.
Suggested by James Lowden on docs@.
2014-11-26 23:44:25 -06:00
Benjamin Peterson 72275ef7c3 remove incorrect plural 2014-11-25 14:54:45 -06:00
Berker Peksag 8a9c682d41 Issue #20351: Add examples for csv.DictReader and csv.DictWriter.
Patch by Charles-Axel Dein.
2014-11-24 23:50:46 +02:00
Ned Deily 40ce014baf Fix faulty indent. 2014-11-23 20:55:55 -08:00
Benjamin Peterson e3e7d40514 pep 476: verify certificates by default (#22417) 2014-11-23 21:02:02 -06:00
Benjamin Peterson b206473ef8 give urllib.urlopen a context parameter (closes #22927) 2014-11-23 20:55:24 -06:00
Benjamin Peterson 6fa40c496e fix versionchanged version 2014-11-23 20:13:55 -06:00
Benjamin Peterson 31aa69ead5 allow hostname to be passed to SSLContext even if OpenSSL doesn't support SNI (closes #22921)
Patch from Donald Stufft.
2014-11-23 20:13:31 -06:00
Benjamin Peterson fcfb18ee2b allow passing cert/ssl information to urllib2.urlopen and httplib.HTTPSConnection
This is basically a backport of issues #9003 and #22366.
2014-11-23 11:42:45 -06:00
Ned Deily 86b36e5ec5 Fix 2to3 reference link in pyporting.rst. 2014-11-22 16:03:40 -08:00
Donald Stufft 527d4ace85 Issue #22827: Backport the new Distributing and Instaling Docs from 3.4 2014-11-20 09:38:31 -05:00
Ned Deily 3f1d0b3121 Issue 22878: PEP 477 - "make install" and "make altinstall" integration
The backport of ensurepip to 2.7.9 allows pip to optionally be installed
or upgraded using the bundled pip provided by the new ensurepip module.
The option can be specified persistently using the configure option:

    ./configure --with-ensurepip[=upgrade|install|no]

It can also be overridden on either the "install" or "altinstall" targets:

    make [alt]install ENSUREPIP=[upgrade|install|no]

For Python 2, the default option is "no" (do not install pip).
2014-11-20 02:11:03 -08:00
Georg Brandl 05e7c9ea6f Fix description. 2014-11-14 11:20:07 +01:00
Georg Brandl 96c4de960c Closes #22868: make example less ambiguous. 2014-11-14 11:12:53 +01:00
Nick Coghlan 01bd3c1231 Close #22300 by tweaking 2.7.9 What's New announcements 2014-11-14 20:05:04 +10:00
Donald Stufft 8aaff54db3 Implement PEP 477 - Backport ensurepip (PEP 453) to 2.7
* Backports ensurepip to the 2.7 branch
* Backports some of the improved documentation to the 2.7 branch.
* Adds a private backport of the 3.x mock library as test._mock_backport
  to enable saner testing of ensurepip.

Key Differences from 3.x:

* Ensurepip does not have any Makefile integration, specifically
  it is not ran by default in the Makefile.
* There is no venv module in 2.7, so downstream distributors can
  completely disable ensurepip, ideally with a message redirecting
  to the correct way to install pip.
* To match the ``python`` command in 2.7, ensurepip will install
  the unversioned ``pip`` command as well.
* No-op and hide --default-pip and add --no-default-pip to restore
  the 3.x behavor on 2.7.
2014-11-11 10:24:11 -05:00
Serhiy Storchaka 04eee63949 Issue #22845: Improved formatting of dis documentation. 2014-11-11 10:02:57 +02:00
Raymond Hettinger 3454941d26 Use internal links where possible 2014-11-09 17:25:42 -08:00
Raymond Hettinger ccae479e2d Issue 22830: Clarify docs for functools.cmp_to_key(). 2014-11-09 17:10:17 -08:00
Steve Dower b3067a2023 Fixes path to patchlevel.py in doc/make.bat 2014-11-05 20:13:46 -08:00
Georg Brandl a1137fba89 Closes #22525: clarify documentation for ast.literal_eval(). 2014-11-05 20:20:28 +01:00
Georg Brandl 34d1597bb7 #22613: fix several factual errors in builtin docs (thanks Jacques Ducasse) 2014-10-31 09:41:46 +01:00
Georg Brandl 500380135b #22613: minor other fixes in library docs (thanks Jacques Ducasse) 2014-10-31 10:25:48 +01:00
Georg Brandl fb52e38aba #22613: document Cmd.cmdqueue (thanks Jacques Ducasse) 2014-10-31 10:25:38 +01:00
Georg Brandl c182f888db minor grammar fixes (from docs@python.org) 2014-10-31 09:29:38 +01:00
Georg Brandl 65566984b0 rstlint: make the "html leaked markup" regex a bit less sensitive 2014-10-30 22:49:06 +01:00
Georg Brandl d4754b0a9d rstlint: add more directives we use 2014-10-30 22:35:55 +01:00
Georg Brandl f3f50526cc Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:26:26 +01:00
Georg Brandl 0f5d6c00b4 Fixing broken links in doc, part 4: some more breaks and redirects 2014-10-29 10:57:37 +01:00
Georg Brandl cea2725736 linkcheck: ignore issue URLs and PEP URLs (the latter until the PEPs are on www.python.org again). 2014-10-29 10:57:01 +01:00
Georg Brandl 97ae4660e1 Fixing broken links in doc, part 3: the rest 2014-10-29 10:26:56 +01:00
Georg Brandl 0ffb46261c Fixing broken links in doc, part 2: howto/ 2014-10-29 09:37:43 +01:00
Georg Brandl fa55a317e4 Fixing broken links in doc, part 1: faq/ 2014-10-29 09:24:54 +01:00
Georg Brandl ea64fb734f Fix external links to docs.python.org to use internal links instead. 2014-10-29 09:00:30 +01:00
Georg Brandl 66e624b18c Remove now-dead link to IDLE debugger doc and add PyCharm to the commercial IDEs. 2014-10-29 08:55:14 +01:00
Georg Brandl 00da140c63 Update "where is python.org hosted" FAQ. 2014-10-29 08:52:43 +01:00
Georg Brandl 06f3b3b98c Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl 42bf486302 Use https:// URLs in the HTML templates. 2014-10-29 08:36:15 +01:00
Georg Brandl 23dd65bd88 Doc readme: Fix markup, use https:// URLs. 2014-10-29 08:18:43 +01:00
Georg Brandl ecc0cc0f8c Adjust the author field of the .tex files to reflect that docs are now maintained by all of us 2014-10-29 08:14:04 +01:00
Georg Brandl 160cbce92a Move Sphinx templates and extensions to their own subdirs. 2014-10-29 08:41:02 +01:00
Georg Brandl 8a91c5b999 Fix link to ABOP install chapter. 2014-10-28 23:00:25 +01:00
Georg Brandl 83ac36dd53 Update Opensolaris advice to OpenCSW instead of defunct Blastwave. 2014-10-28 22:52:49 +01:00
Georg Brandl 443a43dc46 Closes #22249: use IPPROTO_TCP constant instead of SOL_TCP constant for getaddrinfo() proto param 2014-10-28 22:45:27 +01:00
Georg Brandl e9e24b55a6 Closes #22748: there are no PyString C functions in 3.x. 2014-10-28 21:38:49 +01:00
Georg Brandl ae4ca79574 Closes #22736: move seealso to the bottom of the section about RE syntax. 2014-10-28 21:41:51 +01:00
Ezio Melotti 9f8a5b1abd #22237: document that sorted() is guaranteed to be stable. Initial patch by Martin Panter. 2014-10-28 12:57:11 +01:00
Terry Jan Reedy ed91883bf5 Issue #16863: Explain difference between text and 2.7 behavior. 2014-10-22 17:59:53 -04:00
Vinay Sajip 55640c1315 Updated cookbook entry to replace shutil.chown with os.chown. 2014-10-22 18:27:59 +01:00
Antoine Pitrou 9e4a9339e1 Issue #22660: update various mentions in the ssl module documentation. 2014-10-21 00:14:39 +02:00
Benjamin Peterson dd1be619e2 make plural s lowercase 2014-10-19 10:48:50 -04:00
Zachary Ware 7ca2a9008d Fix a typo caught by Gabriella Capone on docs@ 2014-10-19 01:06:58 -05:00
Benjamin Peterson 867dc37822 remove link to the 'original package specification'; I doubt it's useful anymore (closes #22657) 2014-10-17 11:07:14 -04:00
Alex Gaynor 9c2ce254bb Use https:// URLs for the bug tracker in the :issue: role.
Thanks to Ezio for noticing this
2014-10-13 12:58:03 -07:00
Alex Gaynor 5560b4208f issue22626: Use https:// for a link to the bug tracker 2014-10-13 12:55:21 -07:00
Benjamin Peterson 078ece20e4 note xmlrpclib doesn't verify certs (yet) 2014-10-13 11:53:54 -04:00
R David Murray 9511b546e4 #17325: Improve distutils PyPI documentation.
Patch by Chris Jerdonek.
2014-10-12 13:15:40 -04:00
Georg Brandl f8757fd356 Closes #22586: clarify meaning of allow_fragments in urlparse. 2014-10-12 16:13:32 +02:00
Zachary Ware f126fa59f6 Issue #15414: Clean and correct the os.path.join docs.
In particular, correctly describe the behavior of ntpath.join.

Based on a patch by Dave Sawyer.
2014-10-10 16:03:14 -05:00
Terry Jan Reedy c305ad7350 Issue #22575: Revise bytearray entry for 2.7. 2014-10-10 13:02:55 -04:00
R David Murray a68109a248 #0712: 2to3 has a new "asserts" fixer that replaces deprecated names of unittest methods.
Patch by Ezio Melotti, docs by Berker Peksag.
2014-10-09 23:13:42 -04:00
Victor Stinner a6066ce6b1 Closes #22580: Fix documentation of PyUnicode_Tailmatch()
The result type is Py_ssize_t (and not int).
2014-10-09 11:14:04 +02:00
Benjamin Peterson 05179d528c use source role instead of linking to svn 2014-10-06 21:10:25 -04:00
Georg Brandl 7788dba204 Closes #19071: "self" argument is not the module for module functions in 2.x. 2014-10-06 18:01:02 +02:00
Georg Brandl 436ebf8a52 Closes #16155: fix a few errors in doctest output of the FAQ pages. 2014-10-06 17:51:46 +02:00
Georg Brandl 8d867cb718 Closes #17057: fix grammar in old-style vs new-style class docs. 2014-10-06 17:46:43 +02:00
Georg Brandl 71ede5047d Closes #14303: socket.makefile() does not call dup() anymore on the socket fd. 2014-10-06 16:36:20 +02:00
Georg Brandl 8b14dd39cf Closes #10031: overhaul the "imports" section of the programming FAQ.
Remove the advice to never use relative imports.
Remove the advice to locally import modules in __init__, it is a strange practice.
Remove the advice to use "from ... import *" with some modules.
2014-10-06 16:21:08 +02:00
Georg Brandl b74cf54a64 Closes #22507: document that PyType_IsSubtype does not call __subclasscheck__. 2014-10-06 14:15:06 +02:00
Georg Brandl 4a89fd9ba8 Document builtin classes as such, not functions. 2014-10-06 13:54:36 +02:00
R David Murray 72601e1456 #14201: Update ctypes docs to match behavior changed from 214b28d7a999.
Original patch by Erik Johansson, slightly updated by Meador Inge.
2014-10-04 18:24:32 -04:00
R David Murray c6cf35d36d #14056: Small improvements to the tarfile documentation.
Patch by Éric Araujo with help from Lars Gustäbel.
2014-10-03 20:30:42 -04:00
Zachary Ware 06b74a762b Fix a few typo/grammar issues in the multiprocessing docs.
Reported by Scott Hinton on docs@.
2014-10-03 10:55:12 -05:00
Georg Brandl dc14bc58e3 merge heads 2014-10-02 08:39:42 +02:00
Georg Brandl c066105e34 closes #22528: add source links to symtable and compileall 2014-10-02 08:38:39 +02:00
Georg Brandl 14b5a4da27 Closes #22537: Make sphinx extensions compatible with Python 2 or 3, like in the 3.x branches 2014-10-02 08:26:26 +02:00
Terry Jan Reedy b10b8ead13 Issue 22465: grammar, number agreement. 2014-09-30 19:07:45 -04:00
Georg Brandl 3e430eba6e Remove duplicate PyLong function descriptions. 2014-09-30 23:02:52 +02:00
Georg Brandl f16fbf940f Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore. 2014-09-30 22:51:30 +02:00
Georg Brandl bb675280d9 Dont define an empty SPHINXOPTS, which overrides a definition from the environment. 2014-09-30 22:23:57 +02:00
Georg Brandl 75070f0304 Prepare sphinx extensions for 1.3. 2014-09-30 22:17:41 +02:00
Benjamin Peterson a76e4d8376 add link to pdb source (closes #22528) 2014-09-30 16:02:06 -04:00
R David Murray 276a0a578e #20135: FAQ entry for list mutation.
This is a perennial question and something someone opens a ticket for probably
every other month or so, so I'm surprised we didn't already have a FAQ entry
for it.

The original patch was written by M. Votz, refined first by Ezio Melotti and
further refined by me.
2014-09-29 10:23:43 -04:00
Berker Peksag 12f053215f Issue #17462: Add a paragraph about advantages of argparse over optparse.
Patch by Anastasia Filatova.
2014-09-26 15:39:05 +03:00
Benjamin Peterson d1a4f99159 allow archives for rc releases to be built (closes #22484) 2014-09-24 20:22:24 -04:00
Georg Brandl 3e46d7cba2 Doc: fix usage of deprecated config value "unused_docs", and a duplicate object name. 2014-09-21 00:42:40 +02:00
Georg Brandl 967d41fff1 Doc: remove invalid uses of ":option:" which will emit warnings in Sphinx 1.3. 2014-09-21 00:35:08 +02:00
Benjamin Peterson 175b1a7b3e remove extra letter 2014-09-19 17:29:08 -04:00
Benjamin Peterson b332f2a700 standardize pep 466 relnote style 2014-09-19 17:27:03 -04:00
Benjamin Peterson f61e24db06 whatsnew for pep 466 ssl backport 2014-09-19 17:23:21 -04:00
Vinay Sajip f40a407577 Issue #22436: Improved documentation for getEffectiveLevel() and getLevelName(). 2014-09-18 17:46:58 +01:00
Senthil Kumaran 74012c1795 Issue #16827: Make Interpreter introduction section of the tutorial more
focussed and move advanced section and customization information to a separate
file called appendix.

Patch credits: Jamayla Wiley, Ya-Ting Huang and James Brewer.
2014-09-18 21:29:21 +08:00
Benjamin Peterson 05137ed14f make hg link secure 2014-09-13 01:44:34 -04:00
Benjamin Peterson 7709a53d58 y2k compliance, lol (closes #22380) 2014-09-10 17:13:06 -04:00
Serhiy Storchaka 581448be80 Issue #22369: Change "context manager protocol" to "context management protocol". 2014-09-10 23:46:14 +03:00
Serhiy Storchaka ea217728c3 Issue #20643: Fixed references to the next() method (distinguish from the
next() function).
2014-09-05 23:34:12 +03:00
Benjamin Peterson 342fd18f53 backport our own copy of the ref-counting extension 2014-09-05 10:03:26 -04:00
Benjamin Peterson 423f1282b3 remove automatic svn checkout of sphinx and its deps from Doc/Makefile
Users are now required to install Sphinx themselves as is already the case with
the Python 3 branch.
2014-09-04 23:07:03 -04:00
Benjamin Peterson beda11047c fix malformed use cmdoption directive 2014-09-04 22:40:34 -04:00
Alex Gaynor 162126d567 Fixed the versionadded in the docs for the backport in 16c86a6bdbe2 2014-09-04 13:37:07 -07:00
Alex Gaynor e98205d798 Issue #20421: Add a .version() method to SSL sockets exposing the actual protocol version in use.
Backport from default.
2014-09-04 13:33:22 -07:00
Benjamin Peterson ceb0e1d751 the correct role is :meth: not :method: 2014-09-04 11:50:14 -04:00
Benjamin Peterson 4ec38f6b54 remove script that now lives at https://github.com/python/docsbuild-scripts 2014-09-01 23:00:11 -04:00
Ned Deily ac51e0dd82 Issue #22320: Fix broken link in the General Python FAQ.
Original patch by Josh Lynn.
2014-08-31 23:57:13 -07:00
Benjamin Peterson 3f48d39493 getuid() returns real process id not effective (closes #22307) 2014-08-30 21:04:15 -04:00
Benjamin Peterson 0062d1e7f4 PEP 466: backport hashlib algorithm constants (closes #21307) 2014-08-28 09:41:29 -04:00
Benjamin Peterson 13056bff66 correct call grammar error (#3473) 2014-08-28 00:05:52 -04:00
Terry Jan Reedy a58b255a8e Issue #22243: fix except grammar in reference. 2014-08-23 19:29:40 -04:00
Nick Coghlan 62990a42ae Update PEP 466 What's New in 2.7 section 2014-08-23 14:45:44 +10:00
Ned Deily 9d6488a1f0 Issue #22199: Make get_makefile_filename() available in Lib/sysconfig.py
for 2.7 to match other versions of sysconfig.
2014-08-22 13:48:06 -07:00
Benjamin Peterson daeb925cc8 backport many ssl features from Python 3 (closes #21308)
A contribution of Alex Gaynor and David Reid with the generous support of
Rackspace. May God have mercy on their souls.
2014-08-20 14:14:50 -05:00
Zachary Ware 67310859d1 Issue #22178: Fix the date of the Windows epoch (Jan 1, 1601). 2014-08-11 14:58:37 -05:00
Raymond Hettinger 575ee4c4c7 Issue #22174: Clean-up grammar and ambiguities in property() docs. 2014-08-10 10:44:21 -07:00
Vinay Sajip 075588f1af Issue #22130: Corrected fileConfig() documentation. 2014-08-05 10:32:06 +01:00
Ezio Melotti 249fcf6261 #21928: clarify functools.wraps docs. 2014-08-05 08:14:28 +03:00
Ezio Melotti c468abafc7 #18034: update FAQ to suggest importlib.import_module instead of __import__. Patch by Wouter van Heyst. 2014-08-04 19:34:29 +03:00
Jason R. Coombs c4a907dbc1 Issue #13540: Merge commits 2014-08-03 14:57:20 -04:00
Jason R. Coombs 2b492032f2 Issue #13540: Update references to Action class to match syntax used for other classes in this file. 2014-08-03 14:54:11 -04:00
Victor Stinner fe9ebe4f4f Issue #16133: The asynchat.async_chat.handle_read() method now ignores
socket.error() exceptions with blocking I/O errors: EAGAIN, EALREADY,
EINPROGRESS, or EWOULDBLOCK. Initial patch written by Xavier de Gaye.
2014-07-24 19:15:00 +02:00
Andrew Svetlov 909d61f7dd Fix grammar 2014-07-24 08:08:15 +03:00
Zachary Ware 85b5b73999 Fix minor typo in round docs. Reported by Scott Hinton on docs@. 2014-07-22 13:14:54 -05:00
Serhiy Storchaka 7f7d99c279 Issue #15759: "make suspicious", "make linkcheck" and "make doctest" in Doc/
now display special message when and only when there are failures.
2014-07-22 10:28:36 +03:00
Jason R. Coombs 69cd346387 Issue #13540: Removed redundant documentation about Action instance attributes. Updated example and documentation per recommendations by Steven Bethard in msg149524. 2014-07-20 10:52:46 -04:00
Benjamin Peterson 8f25762a94 args doesn't need to be a tuple (closes #17210) 2014-07-19 16:34:33 -07:00
Mark Dickinson 70beff1105 Issue #22006: Remove outdated thread module caveat. Thanks Dan O'Reilly for the report. 2014-07-19 21:47:13 +01:00
Zachary Ware a2dd3b23af Issue #22004: Correct an argument name. 2014-07-18 09:11:48 -05:00
Zachary Ware 2d011e6c2c Fix a minor typo in the turtle docs. Found by Brandon Passmore on docs@. 2014-07-16 14:48:11 -05:00
Zachary Ware 65a6436b5f Fix typo found by Scott Hinton on docs@ 2014-07-07 15:31:21 -05:00
Ezio Melotti 4f7e09a9eb #20135: move FAQ about mutable default arguments to the programming FAQs page. 2014-07-06 20:53:27 +03:00
Raymond Hettinger 809b665b57 Fix guidance for subclassing collections.Set() 2014-07-03 00:30:52 +01:00
Zachary Ware 5b1b38cbef Issue #14097: Backport 796d1371605d and subsequent changes.
The 2.7 tutorial introduction now matches the 3.x introduction as rewritten
by Ezio Melotti, with appropriate changes for 2.x.
2014-07-01 14:25:34 -05:00
Berker Peksag 86af310c15 Fix typo pointed out by Dmitry Chaplinsky on docs@. 2014-06-28 03:12:37 +03:00
Ned Deily 5937f39aee Issue #21875: Remove vestigial references to Classic Mac OS in os module docs. 2014-06-26 23:38:14 -07:00
Berker Peksag e75f527b5a Issue #19897: Use python as executable instead of python3. 2014-06-26 23:27:26 +03:00
Jesus Cea 6d52ced4ce Closes #20872: dbm/gdbm/ndbm close methods are not documented 2014-06-25 12:55:48 +02:00
Vinay Sajip 7de99717c8 Fixed typo in documentation. 2014-06-25 07:29:19 +01:00
Raymond Hettinger 58eb605ca3 Issue #11974: Add tutorial section on class and instance variables
(Based on a patch from Renee Chu.)
2014-06-23 18:03:21 -07:00
Benjamin Peterson ecb4a1e49a clarify that islink only really works if python knows about symlinks (closes #13143)
Patch from Yayoi Ukai.
2014-06-22 17:59:35 -07:00
Senthil Kumaran 454a5155d2 issue 20091 - index entry for __main__ in runpy docs. 2014-06-20 01:36:58 -07:00
Ezio Melotti 33b810d272 #21690: fix a couple of links in the docs of the re module. Noticed by Julian Gilbey. 2014-06-20 00:47:11 +03:00
Zachary Ware 487a143c58 Fix typo reported by Jesse W on docs@ 2014-06-16 11:13:01 -05:00
Jesus Cea ee2cb3fa9b Closes #21759: URL Typo in Documentation FAQ 2014-06-16 14:11:14 +02:00
Terry Jan Reedy 9f2dcd227c Issue #19362: Tweek len() doc and docstring to expand the indicated range of
arguments. Original patch by Gareth Rees.
2014-06-16 03:05:30 -04:00
Benjamin Peterson 87d0136416 clarify when the list of subdirectories is read (closes #13779) 2014-06-15 20:51:12 -07:00
Benjamin Peterson efda558b60 document IOBase.__del__'s behavior (closes #21764)
Patch from Nikolaus Rath.
2014-06-14 18:51:34 -07:00
R David Murray ec92b4a9fa #5904: Add sentence about the encoding of strftime's result. 2014-06-13 17:23:34 -04:00
Terry Jan Reedy 925c6ad85b Issue #21726: Remove unnecessary and contextually wrong line. 2014-06-13 14:57:44 -04:00
Senthil Kumaran df0e8f91c8 #21693 - Fix the broken link for pylons project. 2014-06-11 06:18:43 -07:00
R David Murray dd35484662 #20903: clarify what happens when an smtp connection timeout occurs.
Patch by Milan Oberkirch.
2014-06-09 16:40:47 -04:00
Benjamin Peterson 806f9d704f document TokenError and unclosed expression behavior (closes #12063)
Patch by Amandine Lee.
2014-06-07 17:47:41 -07:00
Benjamin Peterson 4547d371c6 specify that getuid() returns the real uid (closes #10503)
Patch by εσχατοκυριος.
2014-06-07 13:50:34 -07:00
Benjamin Peterson 3afd956e09 document the compress_level argument to tarfile.open (closes #21404)
Patch by Katherine Busch.
2014-06-07 12:45:37 -07:00
Nick Coghlan 4807dd0490 Updates to Python 2.7 What's New preamble
- refers to release PEP for lifecycle information
- refers to Python Package Index for migration tools
- covers enhancements added in maintenance releases

Closes issue #21569
2014-06-07 23:36:13 +10:00
R David Murray 7b02ef0085 #21653: fix doc for return type of sqlite3.Row.keys(). 2014-06-05 15:15:43 -04:00
Senthil Kumaran 1e927094d5 Update references to Python docs in the sidebar index.
Patch contributed by Auke Willem Oosterhoff.
2014-06-02 22:57:07 -07:00
Terry Jan Reedy a4b538df75 Issue 21533: Dicts take iterables, not iterators. Patch by Wolfgang Maier. 2014-06-02 20:42:48 -04:00
Vinay Sajip 9e51f509e6 Updated logging HOWTO section on optimization. 2014-06-02 00:24:47 +01:00
Benjamin Peterson 48f2e99808 backport hashlib.pbkdf2_hmac per PEP 466 (closes #21304)
Backport by Alex Gaynor.
2014-05-31 13:26:22 -07:00
Benjamin Peterson d2058fb5b2 give the correct fixer name (closes #21604) 2014-05-31 13:16:49 -07:00
Terry Jan Reedy 9f7f62f06d Issue #21593: (from StackOverflow) minor doc clarification for re.search. 2014-05-30 16:19:50 -04:00
Vinay Sajip ab2db5815c Issue #21608: Updated HTTPHandler documentation. 2014-05-30 18:46:02 +01:00
Raymond Hettinger 7e19b60dae Issue 21575: Show list.sort() arguments in the tutorial. 2014-05-26 18:49:25 -07:00
Benjamin Peterson 3690d41c48 remove list of example incompatibilities (closes #21434) 2014-05-26 15:38:52 -07:00
Benjamin Peterson 2eff14d333 fix typo in variable name (closes #21586) 2014-05-26 15:10:42 -07:00
Benjamin Peterson d383bafa55 allow doc archives to be built for versions in the rc stage 2014-05-24 15:15:26 -07:00
Terry Jan Reedy cc798377b7 Issue #21545: Add .pop example and tweak comment about pure mutation methods.
Patch prepared by David Harrigan.
2014-05-23 00:34:02 -04:00
Raymond Hettinger fd61349848 Issue 21479: Fix markup for the TarFile.open() classmethod. 2014-05-23 03:43:29 +01:00
Raymond Hettinger 198123c607 Issue 21198: Minor tarfile documentation bug. 2014-05-23 00:05:48 +01:00
Raymond Hettinger 1c1d1e2bae Don't grow strings by concatenation. Use ''.join() instead. 2014-05-18 20:04:01 +01:00
Victor Stinner 07b16159b8 Issue #21488: Fix doc of codecs.decode() and codecs.encode(), no keyword support.
Patch written by Brad Aylsworth.
2014-05-14 17:07:08 +02:00
R David Murray 0eb9ee97b8 #21347: use string not list in shell=True example.
Patch by Akira.
2014-05-14 10:09:21 -04:00
Benjamin Peterson 629026aecc backport hmac.compare_digest to partially implement PEP 466 (closes #21306)
Backport from Alex Gaynor.
2014-05-11 16:11:44 -07:00
Benjamin Peterson e9314e4a3c remove confusing delete indexing (closes #21466) 2014-05-11 11:18:51 -07:00
Zachary Ware 4773b908b1 Add prompts to interactive example.
This makes it match the new example below, and allows Sphinx's
"hide the prompts and output" feature to work.
2014-05-06 09:18:17 -05:00
Zachary Ware 1512143ef0 Issue #21366: Document the fact that ``return`` in a ``finally`` clause
overrides a ``return`` in the ``try`` suite.
2014-05-06 09:07:13 -05:00
Tim Golden e9864c5e30 Issue #19630 Emphasise that the file parameter to marshal.dump must be a real file object 2014-04-29 16:11:18 +01:00
Terry Jan Reedy f3ae10e7ca Closes #21055: Index (augmented) assignment symbols. 2014-04-29 01:19:05 -04:00
Terry Jan Reedy cd3d741451 Closes 21048: Index 'as' in import and with statements. 2014-04-29 00:58:48 -04:00
Terry Jan Reedy 0fe1d0a597 Closes #21026: Augment site doc based on experiments. Patch by Carol Willing. 2014-04-29 00:31:46 -04:00
R David Murray 9b244ad12d #18243: Remove obsolete cautionary note from email mktime_tz docs. 2014-04-26 19:05:03 -04:00
Stefan Krah 32ae4378b9 Issue #17145: Document array.array buffer interface limitations. 2014-04-26 22:50:25 +02:00
Benjamin Peterson 10c7781b90 fix off-by-one error (closes #21330) 2014-04-22 21:54:10 -04:00
R David Murray dd967efae9 #18628: clarify index entry for source file encoding declaration. 2014-04-16 21:57:38 -04:00
Terry Jan Reedy 0d1e44b61e #18566: Whitespace 2014-04-15 23:44:10 -04:00
Terry Jan Reedy e804efa6bb Issue #18566: Clarify unittest setUp, tearDown doc. Patch by Nitika Agarwal. 2014-04-15 23:38:11 -04:00
Vinay Sajip 51f80c12a4 Issue #21245: updated documentation on exception() method and function. 2014-04-15 23:11:15 +01:00
Gregory P. Smith 49bf4ce563 whitespace chaps my hide 2014-04-15 08:01:27 -07:00
Gregory P. Smith 8f813fe2f2 Some cleanup of the subprocess docs in 2.7. Adds a reference to the
subprocess32 project in PyPI for posix users.
2014-04-15 07:59:44 -07:00
Benjamin Peterson 5c863bf938 when an exception is raised in fdopen, never close the fd (changing on my mind on #21191) 2014-04-14 19:45:46 -04:00
Terry Jan Reedy f7568e0a8a Closes #20956: 2.7 tokenize does not produce named tuples. Patch by Sam Kimbrel. 2014-04-14 16:17:09 -04:00
Mark Dickinson f10cc46ad7 Issue #20624: Merge exception docs tweak from 3.4 branch. 2014-04-14 11:33:46 -04:00
Ned Deily 4624b00d67 Remove references to the obsolete Mac Carbon modules in the GUI
section of the FAQ.
2014-04-12 09:31:28 -07:00
Terry Jan Reedy 94fb85e765 Issue #21170: Removed invalid parameter names from unittest doc.
Patch by Kushal Das.
2014-04-11 14:11:00 -04:00
Benjamin Peterson 02ab7a84ef make sure fdopen always closes the fd in error cases (closes #21191) 2014-04-09 15:40:18 -04:00
Senthil Kumaran d546009677 issue #21190: Fix the docs README link 2014-04-09 11:41:02 -04:00
Mark Dickinson 05bbb8cbcf Issue #21179: Fix description of 'round' function for numbers.Real. 2014-04-09 07:03:27 -04:00
Benjamin Peterson 96c9a35815 PySequence_Fast generally returns a list not a tuple (closes #16395) 2014-04-08 10:48:36 -04:00
Benjamin Peterson 236d9f8cd6 the name of the slot of nb_multiply not nb_mul 2014-04-08 10:44:30 -04:00
Benjamin Peterson c0f5063031 fix verb (closes #21174) 2014-04-07 19:34:33 -04:00
Senthil Kumaran eb6a101dd0 minor docfix (reported at docs@python.org) trace.py argument is --count not --counts 2014-04-06 10:58:51 -07:00
Benjamin Peterson b41299e498 note that the hash of an arbitrary object is only derived from its address (closes #21154)
Patch from Armin Rigo.
2014-04-04 09:58:13 -04:00
Raymond Hettinger 9190b6f4a6 Issue 21125: minor wording tweak. 2014-04-01 22:11:34 -07:00
Zachary Ware aa7385561d Issue #15067: Remove reference to a rejected PEP.
Further explanation of the concept stands alone without this reference,
no need to potentially confuse people by bringing up a feature that
doesn't exist.
2014-04-01 12:18:58 -05:00
Benjamin Peterson a4598a3008 support CDN purging 2014-03-30 16:43:11 -04:00
Raymond Hettinger 3708349c07 Minor readability improvement. 2014-03-29 11:49:11 -07:00
Georg Brandl 0913bff8bc Update suspicious ignore file. 2014-03-28 20:07:35 +01:00
Ned Deily b693e9fc5b Issue #6676: Ensure a meaningful exception is raised when attempting
to parse more than one XML document per pyexpat xmlparser instance.
(Original patches by Hirokazu Yamamoto and Amaury Forgeot d'Arc, with
suggested wording by David Gutteridge)
2014-03-27 16:38:32 -07:00
Vinay Sajip 33a431cb3c Updated external link in documentation. 2014-03-25 11:20:22 +00:00
Georg Brandl 0fef31efc2 Closes #21045: make the Qt help build not look completely stupid 2014-03-25 10:12:47 +01:00
Georg Brandl fbd2db5005 Closes #18456: Doc fix: PyDict_Update only works with dict-like objects, not key-value sequences. Patch by priyapappachan. 2014-03-25 09:34:30 +01:00
Donald Stufft 74a4ebaed0 Issue #21043 - Remove CACert.org from the recommendations 2014-03-24 19:49:42 -04:00
Zachary Ware 163a214df8 Use "x" instead of "i" for s.index and s.count entries in sequence ops table.
Suggested by Bruce Esrig on docs@.
2014-03-20 11:00:29 -05:00
Zachary Ware 5c1d3ddfa5 Issue #20966: Fix Tkinter Resources link 2014-03-18 09:18:53 -05:00
Georg Brandl b553ce1736 Update doc version switcher for 3.4/3.5. 2014-03-17 07:36:45 +01:00
Antoine Pitrou c7692805f7 Close #16665: improve documentation for hex(). Patch by Jessica McKellar. 2014-03-16 02:12:20 +01:00
Benjamin Peterson e530f26864 send people to the right editors page (#20938) 2014-03-15 15:23:32 -05:00
Éric Araujo 01111e85b8 Clarify distutils’ clean command (ref #6142) 2014-03-13 16:17:11 -04:00
Benjamin Peterson 944996ff20 remove unnecessary word (closes #19060)
Patch by Anastasia Filatova.
2014-03-12 21:41:35 -05:00
Éric Araujo 31fe52dc9e Make distutils error messages more helpful (#11599).
When running external programs such as a C compiler and getting an
error code, distutils only prints the program name.  With this change,
one can get the full command line by setting the DISTUTILS_DEBUG
environment variable.

This should have no compatibility issues, unless there are tools
that depend on the exact format of distutils debug messages.
2014-03-12 22:19:39 -04:00
Éric Araujo 69d096597d Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
2014-03-12 19:35:54 -04:00
Éric Araujo 3d1134e395 Avoid “error: None” messages from distutils (#4931).
Thanks to Amaury Forgeot d’Arc and Philip J. Eby.
2014-03-12 03:14:48 -04:00
Éric Araujo fd0c2f5711 Define what “updating” means in docs for open (#19627).
Original patch by Lina Clark.
2014-03-12 02:16:37 -04:00
R David Murray 8de21188ae #20030: doc that TestLoader.discover returns a TestSuite.
Patch by Lita Cho.
2014-03-11 18:12:25 -04:00
Benjamin Peterson 841da4ed22 sync pyporting howto from python 3 docs 2014-03-11 14:28:37 -05:00
Georg Brandl 6d07641fce #13530: port to 2.7 branch (document what os.lseek returns). 2014-03-11 10:28:56 +01:00
Georg Brandl 418b1eab91 Closes #20090: update Doc/README and the error message in sphinx-build.py to make
it clear that any Python 3.x is not usable with the checked out Sphinx.
2014-03-10 19:26:57 +01:00
Benjamin Peterson 84f323eae7 note that future_builtin's map is not quite like python 3's (closes #19363)
Patch by Gareth Rees.
2014-03-09 14:01:09 -05:00
Georg Brandl 3bca761ae8 merge 2014-03-09 10:23:24 +01:00
R David Murray 17a4322d09 #20628: wrap lines to < 80. 2014-02-24 15:36:45 -05:00
R David Murray d2b5b316ab #20628: make it clear that DictReader/Writer *fieldnames* is a Sequence.
Patch by Sean Rodman.
2014-02-24 15:35:19 -05:00
Georg Brandl 3cb99f3911 Closes #20735: remove erroneous deprecated marker from stringprep docs 2014-02-24 09:26:53 +01:00
Benjamin Peterson 82c25876ba use sphinx from its own virtualenv (closes #20693) 2014-02-22 01:32:50 -05:00
Ezio Melotti 207b5f466d #19890: fix typo in multiprocessing docs. Patch by Mike Short. 2014-02-15 16:58:52 +02:00
Benjamin Peterson 93cd25d0a8 fix links to builtin repr function (closes #20573) 2014-02-14 14:10:39 -05:00
Ezio Melotti f6c0ec4ff0 #19680: add back documentation for print and exec in the interactive help. 2014-02-14 07:04:15 +02:00
Ezio Melotti 9c96f0ba29 #19906: clarify note in urllib docs. 2014-02-10 09:59:04 +02:00
Vinay Sajip 8bf70f74cf Issue #20509: Added cross-reference in documentation. 2014-02-04 16:25:41 +00:00
Benjamin Peterson 60f0793c30 use system mercurial 2014-02-03 13:33:56 -05:00
Vinay Sajip 5146825e00 Added cookbook entry on logging filter configuration using dictConfig(). 2014-02-03 11:51:22 +00:00
Antoine Pitrou 8a2e22ef35 Issue #20423: fix documentation of io.StringIO's newline parameter 2014-02-02 22:48:25 +01:00
Mark Dickinson 383952d52c Issue #19683: Add __closure__ and other missing attributes to function docs. 2014-02-01 16:32:40 +00:00
Zachary Ware c82e27bf9a Fix unfinished thought in xml overview page. Suggested by Bo Bayles on docs@. 2014-01-31 11:27:24 -06:00
Benjamin Peterson 072cd0c884 update sphinx url 2014-01-25 13:27:06 -05:00
Benjamin Peterson 72c081d1e7 linkify 2014-01-25 13:26:18 -05:00
Benjamin Peterson d8be9feb45 update hosting faq 2014-01-24 23:59:57 -05:00
Georg Brandl 3ce5255a07 Fix markup error. 2014-01-21 19:21:18 +01:00
Benjamin Peterson ad715d9e97 put notes in a ..note section 2014-01-20 00:10:23 -05:00
Benjamin Peterson 235a7c59f1 document that a new Python thread context is created in ctypes callbacks (closes #6627)
Patch by Nikolaus Rath.
2014-01-20 00:09:53 -05:00
Benjamin Peterson 09421f82eb update pysqlite website (closes #20278) 2014-01-16 09:52:38 -05:00
Vinay Sajip ace08aba65 Clarified documentation note on module-level convenience functions. 2014-01-15 13:27:58 +00:00
Zachary Ware f583f41440 Issue #20255: Update the about and bugs pages. 2014-01-14 16:01:32 -06:00
Zachary Ware aec3065b99 Fix typo. Pointed out by Finn Ellis on docs@. 2014-01-13 20:38:17 -06:00
R David Murray dd1c4fda95 #20236: Fix sphinx markup. 2014-01-13 13:54:54 -05:00
Senthil Kumaran 011097395b Issue #19082: Working SimpleXMLRPCServer and xmlrpclib examples, both in modules and documentation. 2014-01-12 16:04:08 -08:00
R David Murray da0b34cd26 Fix verb tense. 2014-01-08 18:08:37 -05:00
R David Murray 5851218e42 #17282: Document unittest.main defaultTest argument. 2014-01-02 13:38:02 -05:00
Benjamin Peterson 1aeb8cfcfd update copyright year 2013-12-31 22:02:22 -06:00
Antoine Pitrou 63cc99d9a6 Issue #19422: Explicitly disallow non-SOCK_STREAM sockets in the ssl module, rather than silently let them emit clear text data. 2013-12-28 17:26:33 +01:00
R David Murray dfd21d3538 #20063: Remove inaccurate/confusing statement about support of 'pop' method.
Patch by Gennadiy Zlobin.
2013-12-25 22:26:59 -05:00
Serhiy Storchaka b712873a63 Removed spaces before colons and semicolons. 2013-12-24 11:04:06 +02:00
Serhiy Storchaka 610f84af0d Removed spaces before commas and periods. 2013-12-23 18:19:34 +02:00
Antoine Pitrou c96592da4d s/lightweight/minimal/, as per issue #11379. 2013-12-22 01:57:01 +01:00
Vinay Sajip d46a31fc64 Issue #19902: Added list of logging levels. 2013-12-19 11:42:18 +00:00
Zachary Ware b56c517b05 Issue #20005: Fix typo in operator docs. Patch by Claudiu Popa. 2013-12-18 12:18:36 -06:00
Ezio Melotti 91b88c8d87 #19981: fix typo in email.mailbox docs. Patch by Claudiu Popa. 2013-12-14 12:42:29 +02:00
Nick Coghlan 73188fb68b Issue #19407: add Python Packaging User Guide notes
The stdlib docs for package distribution and building extensions
are rather dated, and that isn't expected to change for 2.7 and
3.3.

The Python Packaging User Guide isn't complete either, but it's
already a much better road map for new users than the existing
stdlib docs.
2013-12-10 21:18:32 +10:00
Vinay Sajip d919da9942 Added minor clarification in logging HOWTO. 2013-12-06 11:21:15 +00:00
Antoine Pitrou 197e71bce1 Issue #18840: Introduce the json module in the tutorial, and deemphasize the pickle module. 2013-12-05 23:46:32 +01:00
Kristján Valur Jónsson 222b284911 Issue #7105: weak dict iterators are fragile because of unpredictable GC runs
Backport the fix from pyton 3.x for this issue.
2013-12-05 10:03:45 +00:00
Eli Bendersky 7b2ac60934 Issue #19814: Clarify argparse's docs w.r.t prefix matching 2013-12-02 05:53:35 -08:00
Vinay Sajip e9cb5e9df6 Issue #19789: Clarified documentation for logging.disable. 2013-11-30 22:43:13 +00:00
Serhiy Storchaka 26d936a71e Issue #19795: Improved markup of True/False constants. 2013-11-29 12:16:53 +02:00
Serhiy Storchaka 9f91d35ff3 Issue #19794: Improved markup for True/False constants. 2013-11-26 17:32:03 +02:00
Antoine Pitrou 131336846c Issue #19691: remove outdated mention about RuntimeError 2013-11-25 19:08:32 +01:00
Georg Brandl d061efa3b8 Fix suspicious markup and sort ignorelist. 2013-11-25 08:34:24 +01:00
Georg Brandl 40dcf7f0be Doc/Makefile: also do "make suspicious" during daily autobuild 2013-11-24 16:17:54 +01:00
Ezio Melotti 4645bb61fa Fix indentation in doc example. 2013-11-17 22:07:48 +02:00
Richard Oudkerk a69712c01d Issue 16998: Clarify that += on a shared value is not atomic. 2013-11-17 17:00:38 +00:00
Antoine Pitrou f7a52475a5 Issue #19508: warn that ssl doesn't validate certificates by default 2013-11-17 15:42:58 +01:00
Ezio Melotti e3c61368e3 #19238: fix typo in documentation. 2013-11-17 02:47:12 +02:00
Vinay Sajip 6afafc7ea4 Issue #19504: Used American spelling for 'customize'. 2013-11-15 20:54:15 +00:00
R David Murray a691219716 backport #18985: Improve fcntl documentation. 2013-11-07 10:52:53 -05:00
Nick Coghlan 6a98749e9c Close #17827: Document codecs.encode & codecs.decode 2013-11-04 20:05:16 +10:00
Vinay Sajip 41e9b401dc Issue #19455: Corrected inaccuracies in documentation and corrected some incorrect cross-references. 2013-10-31 01:08:59 +00:00
Christian Heimes db78e4365b fix language 2013-10-29 22:19:39 +01:00
Christian Heimes 88b2220859 Issue #18747: document issue with OpenSSL's CPRNG state and fork 2013-10-29 21:08:56 +01:00
Georg Brandl 712e951f54 Closes #19416: fix references in the nntplib docs. 2013-10-29 08:14:51 +01:00
Georg Brandl 21f2ec6aa4 Fix wrong signature for two-argument newwin(). Found by Jacqueline Leykam on docs@. 2013-10-29 08:10:36 +01:00
Georg Brandl b64f40f3e9 Fix typo: js_JP is not a valid locale. 2013-10-29 08:05:10 +01:00
Tim Golden 17934856dc Issue #15207: Fix mimetypes to read from correct area in Windows registry (Original patch by Dave Chambers) 2013-10-22 20:45:13 +01:00
Ezio Melotti c62403818c #19319: fix ctypes docs: sizeof is an operator in C, not a function. 2013-10-21 04:41:40 +03:00
Ezio Melotti cef2d49122 #19238, #19289: fix description of the align and fill values of the format specification. 2013-10-21 02:53:07 +03:00
Benjamin Peterson 97b36181db fix description of super() behavior on descriptors 2013-10-18 12:57:55 -04:00
Serhiy Storchaka de2f8fadcc Fix markup. 2013-10-18 11:54:52 +03:00
Georg Brandl cea38084eb Closes #19277: document all parameters of compressobj(). 2013-10-17 19:51:00 +02:00
Ezio Melotti 8ad0eac7ff #4965: Implement intelligent scrolling of the sidebar in the docs. 2013-10-14 22:01:28 +03:00
Serhiy Storchaka 0b9a9fd3a0 Issue #19189: Improved cross-references in the pickle module documentation. 2013-10-14 10:43:26 +03:00
Serhiy Storchaka b6f6450488 Merge heads 2013-10-13 23:29:53 +03:00
Georg Brandl b7557af86d Wing IDE is switching to PyQt... 2013-10-13 22:23:27 +02:00
Serhiy Storchaka b33336f650 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:00 +03:00
Serhiy Storchaka 7378d6374c Issue #19197: Improved cross-references in the shlex module documentation. 2013-10-13 21:17:56 +03:00
Serhiy Storchaka 361994c8e9 Issue #19207: Improved cross-references in the os, os.path, and posix modules
documentation.
2013-10-13 20:25:30 +03:00
Georg Brandl 1b1c11d208 Refer to strftime(3) manpage for platform specific format codes.
Suggested by Skip Montanaro on docs@.
2013-10-13 18:28:25 +02:00
Serhiy Storchaka 55c45c71cf Issue #19198: Improved cross-references in the cgi module documentation. 2013-10-13 18:27:51 +03:00
Georg Brandl 65e30a2db5 Closes #13740: SND_NOWAIT seems to be ignored on modern Windows. 2013-10-13 10:49:41 +02:00
Georg Brandl 6e5ae97c95 Closes #15829: document ThreadError and fix exception raised for releasing unlocked locks. 2013-10-13 10:23:27 +02:00
Georg Brandl 52fa1724ce Closes #14486: add versionchanged notices throughout the threading docs for PEP8-compliant APIs; the note at the top of the page is too hard to notice. 2013-10-13 10:07:31 +02:00
Georg Brandl 21721b6be5 Fix a small CSS glitch with deprecated blocks and Sphinx 1.2. 2013-10-13 09:56:20 +02:00
Georg Brandl 0aab3d97ad Fix display of deprecated blocks with Sphinx 1.2. 2013-10-13 09:31:42 +02:00