Commit Graph

20091 Commits

Author SHA1 Message Date
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