Commit Graph

20257 Commits

Author SHA1 Message Date
Benjamin Peterson c6fa90c7ca fix typo in unittest docs (closes #26046)
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
Berker Peksag 6b51ddfa22 Issue #5501: Clarify that invoking freeze_support() on non-Windows platforms has no effect
Patch by Davin Potts and Camilla Montonen.
2016-01-07 18:49:53 +02:00
Senthil Kumaran 788db63265 Fix issue18918 : Attach the pydoc documentation for 'FILES' topic.
Also rebuilt the pydoc_data with this change.
2016-01-06 03:54:18 -08:00
Senthil Kumaran e2e6b54a4c Backport documentation improvement.
Issue24898 - Improve str.find documentation.

Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 18:07:06 -08:00
Senthil Kumaran 8a4e7fd678 Backport doc improvements for Issue21221 - Explain the usage of tm_isdst
attribute of mktime, with valid values and meaning.

Patch contributed by Andrew Scheller.
2016-01-03 01:03:40 -08:00
Zachary Ware fa45a0e3d2 Fix grammar.
Reported by Anatoly Techtonik on docs@
2016-01-01 12:22:16 -06:00
Benjamin Peterson f30bad284b remove some copyright notices supserseded by the toplevel ones 2016-01-01 11:53:47 -06:00
Benjamin Peterson 1f40ece2d7 2016 will be another year of writing copyrighted code 2016-01-01 10:23:45 -06:00
Martin Panter d77fe94b4e Issue #22088: Port base64 character ignoring doc and test from 857d9fe60169 2015-12-14 03:41:59 +00:00
Martin Panter edd6a817d1 Issue #20837: Base-64 alphabet clarification from revision 1853679c6f71 2015-12-14 02:54:40 +00:00
R David Murray b75adccd0a #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:14 -05:00
Zachary Ware 6b93ca6a3b Clarify that only *documentation* bugs should go to docs@python.org 2015-12-09 01:53:44 -06:00
Vinay Sajip c9625c8e4b Issue #25508: Clarify documentation on LogRecord args attribute. 2015-11-24 23:18:30 +00:00
Martin Panter 402803b642 Issue #23200: Document that max_length=0 is not supported 2015-11-18 00:59:17 +00:00
Martin Panter 793ae0d0ae Issue #20468: Remove incorrect information about maxrss and page size
Extract of patch by Ronald Oussoren.
2015-11-17 22:13:47 +00:00
Martin Panter a5d1cf3221 Issue #25615: Document unsorted behaviour of glob; patch by Dave Jones 2015-11-16 23:46:22 +00:00
Martin Panter 5118f7b9af Issue #25017: Document that htmllib is superseded by module HTMLParser 2015-11-14 00:30:46 +00:00
Victor Stinner c0fdd825c2 Issue #25605: Document exceptions raised by fcntl.ioctl() and fcntl.flock() 2015-11-13 09:13:16 +01:00
Zachary Ware db7a1d6e15 Document the BUILD_SET opcode.
Reported by Hrvoje Abraham on docs@.
2015-11-12 10:02:06 -06:00
Zachary Ware 77d61d4156 Rewrite re.VERBOSE section.
It now has slightly better rationale and a less awkward wording in the
explanation.

Inspired by a report of a neither/or conflict by 'animalize' on docs@.
2015-11-11 23:32:14 -06:00
Zachary Ware 2ee55f37c2 Fix use of default reST role 2015-11-05 10:28:18 -06:00
Benjamin Peterson be038077fb remove trailing ws 2015-11-03 22:43:31 -08:00
Benjamin Peterson 40559cedb5 merge heads 2015-11-03 22:42:08 -08:00
Benjamin Peterson 873cad2f16 link to modern PUG url 2015-11-03 22:42:02 -08:00
Serhiy Storchaka c72e66a048 Issue #25523: Backported a-to-an corrections. 2015-11-02 15:06:09 +02:00
Terry Jan Reedy a5ad9da504 Issue #25519: Mark difflib.ndiff as a functions where not already. 2015-10-30 19:41:10 -04:00
Terry Jan Reedy 0a1ba70949 Issue #25432: Explain isinstance behaviour when type is a tuple. 2015-10-28 03:14:46 -04:00
Victor Stinner 15a43ed030 Issue #25461: Rephrase os.walk() doc
Patch written by Bernt Røskar Brenna.
2015-10-23 12:42:39 +02:00
Vinay Sajip 63173a8c7e Added entry to logging cookbook. 2015-10-17 13:55:19 +01:00
Terry Jan Reedy 1c49ec0df0 Issue #24782: Finish converting the Configure Extension dialog into a new
tab in the IDLE Preferences dialog.  Code patch by Mark Roseman.
2015-10-13 22:03:44 -04:00
Benjamin Peterson a20c72a264 actually link to the version attributes documentation 2015-10-11 23:03:22 -07:00
Benjamin Peterson d2a19c2c67 don't mention Python 2.2 (closes #25375) 2015-10-10 23:23:55 -07:00
Martin Panter 4ed35fc4f3 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:52:35 +00:00
Martin Panter dab305ef05 Issue #22413: Document newline effect on StringIO initializer and getvalue
Also add to comment in the C code.
2015-10-10 02:52:30 +00:00
Vinay Sajip 9918775206 Closes #25344: Added cookbook recipe to show buffering of logging events. 2015-10-10 00:49:10 +01:00
Martin Panter 840c82ee88 Issue #25286: Accidentally dropped "the" 2015-10-07 10:39:13 +00:00
Martin Panter 4a33724d47 Issue #25286: Dictionary views are not sequences
Also change glossary heading from "view" to "dictionary view". Patch by Akira
Li.
2015-10-07 10:19:39 +00:00
Martin Panter fcf58a1518 Issue #16701: Document += and *= for mutable sequences 2015-10-03 07:37:22 +00:00
Terry Jan Reedy 195fc2f2aa Issue #25224: README.txt is now an idlelib index for IDLE developers and
curious users.  The previous user content is now in the IDLE doc and is
redundant.  IDLE now means 'Integrated Development and Learning Environment'.
2015-10-02 23:22:54 -04:00
Terry Jan Reedy 958a9c7520 Issue #24028: Add subsection about Idle calltips. 2015-09-29 01:55:50 -04:00
Benjamin Peterson 02dc7d1272 merge heads 2015-09-27 02:08:04 -07:00
Berker Peksag 9fa7e2e5ef Fix broken link in Doc/extending/index.rst 2015-09-27 12:06:26 +03:00
Benjamin Peterson 4e648f6c07 make wikipedia link https 2015-09-27 02:05:01 -07:00
Benjamin Peterson 9b4865ad2b shorten and fix casing of title 2015-09-27 01:23:10 -07:00
Terry Jan Reedy f56f8d1800 Issue #25225: Condense and rewrite Idle doc section on text colors. 2015-09-24 23:13:43 -04:00
Terry Jan Reedy 7cca4e5ba2 Issue 21995: Explain some differences between IDLE and console Python. 2015-09-24 03:09:38 -04:00
Victor Stinner 68dafe5f14 Issue #24894: Document the codec iso8859_11
Patch written by Prashant Tyagi.
2015-09-24 09:05:19 +02:00
Terry Jan Reedy cf5bf82e59 Issue #22820: Explain need for *print* when running file from Idle editor. 2015-09-24 01:39:25 -04:00
Terry Jan Reedy 6741a5ae19 Issue 25224: Augment Idle doc feature list and no-subprocess section
to finish making current README.txt obsolete.
2015-09-23 20:00:22 -04:00
Terry Jan Reedy c7025c6265 Issue #25219: Update doc for Idle command line options.
Some were missing and notes were not correct.
2015-09-23 03:52:18 -04:00
Berker Peksag 0612ae52a0 Issue #23484: Document differences between synchronization primitives of
threading and multiprocessing modules.

In multiprocessing, the name of the first parameter of the acquire methods is
"block", but "blocking" in threading.

This commit also improves documentation of Lock and RLock.

Patch by Davin Potts.
2015-09-21 07:15:52 +03:00
Benjamin Peterson 1b822d0e2f use a more modern UA (#25145) 2015-09-20 23:16:45 +05:00
Benjamin Peterson c717e08720 remove reference to PyGoogle (#25145)
Patch by Bar Harel.
2015-09-20 23:17:41 +05:00
Ethan Furman b85154fa37 Issue24756: clarify usage of run_docstring_examples() 2015-09-17 22:19:48 -07:00
Benjamin Peterson 061653091e fix name of argument in docstring and the docs (closes #25076)
Patch by TAKASE Arihiro.
2015-09-12 17:20:47 -07:00
Serhiy Storchaka 9b2e37f688 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:47:12 +03:00
Martin Panter b2528c92f1 Issue #16473: Fix byte transform codec documentation; test quotetabs=True
This changes the equivalent functions listed for the Base-64, hex and Quoted-
Printable codecs to reflect the functions actually used. Also mention and
test the "quotetabs" setting for Quoted-Printable encoding.
2015-09-12 00:34:28 +00:00
Zachary Ware d0384044ee Fix grammatical error in csv docs.
Reported by Nat Dunn on docs@
2015-09-11 10:51:47 -05:00
Martin Panter 6f80464f4a Issue #25030: Do not document seek() as if it accepts keyword arguments
Patch from Shiyao Ma.
2015-09-11 03:58:30 +00:00
Martin Panter 397c2103f7 Issue #25022: Avoid warning about unused suspicious rule 2015-09-11 02:45:10 +00:00
Zachary Ware 677688be22 Issue #25022: Add NEWS, fix docs to not mention the old example. 2015-09-10 15:50:58 -05:00
Guido van Rossum d076454bd3 Add the original author of profile.py back to the docs, at his request. 2015-09-10 12:11:17 -07:00
Martin Panter 0ed1bcdff8 Issue #23406: Clarify documentation on multiplying a sequence
Patch from Matheus Vieira Portela.
2015-09-07 01:40:33 +00:00
R David Murray bda9bd1d1c #24998: fix cut and paste error in subprocess example. 2015-09-04 10:00:22 -04:00
Raymond Hettinger 9ce9f77983 Improve tutorial suggestion for looping techniques 2015-09-01 02:20:44 -07:00
Martin Panter 6a31bb5cac Issue #24952: Clarify default argument of stack_size() in threading, thread
Patch from Mattip.
2015-08-31 03:40:59 +00:00
Raymond Hettinger fe2f2876ce Make an example a little clearer 2015-08-30 14:48:42 -07:00
Zachary Ware e0c8e26294 Issue #24962: Remove space from filename 2015-08-29 22:25:04 -05:00
R David Murray f79aa5870f #24926: Fix typo in example. 2015-08-24 12:50:50 -04:00
Robert Collins d951625f81 Merge 2.7 heads. 2015-08-24 12:10:23 +12:00
Robert Collins 11ac1a8239 Issue #22812: Fix unittest discovery examples.
Patch from Pam McA'Nulty.
2015-08-24 12:06:18 +12:00
Ned Deily c9a5a19e81 Issue #24079: Improve description of the text and tail attributes for
ElementTree Element objects.  Initial patch by Martin Panter.
2015-08-17 22:10:47 -04:00
Robert Collins 311c8d63e5 Issue #24531: Document that encoding lines cannot follow non-comment lines.
Patch from Terry Reedy
2015-08-06 21:08:44 +12:00
Robert Collins 937f2f70f5 Issue #20769: Improve reload() docs. Patch by Dorian Pula. 2015-08-05 08:16:41 +12:00
Terry Jan Reedy fa002d4cdd Issue #13884: Idle: Remove tearoff lines from menus. Patch by Roger Serwy. 2015-07-30 16:44:09 -04:00
Berker Peksag ffc7e8eebe Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
It should StreamWriter for Codecs.encode() and StreamReader for Codec.decode().

Patch by Nick Weinhold.
2015-07-30 23:27:13 +03:00
Robert Collins f524799a65 Issue #23589: Remove duplicate sentence from the FAQ. Patch by Yongzhi Pan. 2015-07-30 06:14:32 +12:00
Robert Collins 2f2c829688 Issue #23254: Document how to close the TCPServer listening socket.
Patch from Martin Panter.
2015-07-29 12:48:42 +12:00
Benjamin Peterson cdbe6fc23b we don't care about python 1.5.2 2015-07-21 23:17:16 -07:00
Zachary Ware c6fe4dbea5 Issue #24680: Remove random backslash. Patch by cdz. 2015-07-21 22:33:16 -05:00
Benjamin Peterson 26040e87d1 'not' is very important here 2015-07-06 11:28:07 -05:00
Benjamin Peterson 678e7a9080 tighten warning 2015-07-06 09:40:43 -05:00
Zachary Ware e6f87fcfa1 Update Docs/tools/susp-ignored.csv 2015-07-06 00:08:15 -05:00
Ned Deily b2f949aafb Issue #24330: Update IDLE doc and help to note "Configure IDLE" difference
on OS X.  Original patch by André Freitas.
2015-07-04 15:04:42 -07:00
R David Murray 3995421228 #24548: replace dead link with pointer to archive.org. 2015-07-04 15:50:30 -04:00
Terry Jan Reedy e079936241 Issue #24525: Add missing word. Patch by Vincent Legoll. 2015-07-03 19:10:14 -04:00
Berker Peksag 1ecb5ce707 Issue #24496: Backport gzip examples to Python 2.
gzip.open() supports context management protocol in Python 2, so it's better to
use it in the examples section.

Patch by Jakub Kadlčík.
2015-06-25 23:57:42 +03:00
Berker Peksag 6750c8b803 Issue #23684: Clarify the return value of the scheme attribute of ParseResult and SplitResult objects.
Patch by Martin Panter.
2015-06-25 23:47:43 +03:00
Serhiy Storchaka 1670af6c33 Added the const qualifier for char* argument of Py_EnterRecursiveCall(). 2015-06-21 16:26:28 +03:00
Berker Peksag 0e8af341fa Issue #24443: Fix links for Event.clear() and Event.wait() methods.
Patch by Jaivish Kothari.
2015-06-13 11:05:31 +03:00
Terry Jan Reedy 039573dc17 whitespace 2015-06-12 16:47:03 -04:00
Terry Jan Reedy f4ae91382a Issue #24406: Add sentences on dict comparisons, similar to those for Sequence
and set comparisions.  Patch by Gareth Rees.
2015-06-12 16:38:51 -04:00
Benjamin Peterson 822be2ec32 that this is "for Python" is obvious 2015-06-05 21:03:08 -05:00
Ned Deily 43a98df147 Issue #24357: use example.org instead 2015-06-01 21:17:14 -07:00
Ned Deily 14c9ea6e8e Issue #24357: Change host in socket.getaddrinfo example to one that
does support IPv6 and IPv4; www.python.org currently does not.
2015-06-01 18:45:49 -07:00
Benjamin Peterson 78ba242403 update for 3.6 emerging 2015-05-27 18:32:25 -05:00
Ned Deily ad73b5ad58 Issue 24304: Fix broken license link in FAQ. 2015-05-27 15:36:39 -07:00
Terry Jan Reedy 13ab3a46ae Make expression legal python by adding '1'. 2015-05-23 16:16:23 -04:00
Terry Jan Reedy 84924e6e92 Issue #22155: Add File Handlers subsection with createfilehandler to Tkinter
doc.  Remove obsolete example from FAQ.  Patch by Martin Panter.
2015-05-17 14:49:20 -04:00
Andrew Kuchling c711b61ad4 #19934: fix mangled wording 2015-05-13 11:25:40 -04:00
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