Commit Graph

183 Commits

Author SHA1 Message Date
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
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
Ezio Melotti 4645bb61fa Fix indentation in doc example. 2013-11-17 22:07:48 +02:00
Serhiy Storchaka 972788088d Issue #19193: Improved cross-references in the tutorial. 2013-10-09 09:54:32 +03:00
Georg Brandl 3456d4746d Fix typo in example file name. Found by John Bokma on docs@. 2013-10-06 19:21:14 +02:00
Georg Brandl b3d6fe336d Small logical fix in filter() example description. 2013-10-06 11:41:36 +02:00
Georg Brandl 96426886ec Clarify section about source code encoding. 2013-10-06 11:24:48 +02:00
Georg Brandl 76834a1a27 Fix merging mistake: wrong Python version. 2013-10-06 11:08:57 +02:00
Georg Brandl 15d9fe7ecf Fix wrong Python highlighting in directory hierarchy code block. 2013-10-06 11:08:24 +02:00
Georg Brandl cff39b0120 Use "lambda expression" as preferred to "lambda form". 2013-10-06 10:26:58 +02:00
Georg Brandl d6d26ec908 Closes #18646: improve lambda docs in tutorial. Original patch by Terry Reedy. 2013-10-06 10:22:45 +02:00
Raymond Hettinger 668b0058a3 Issue #18031: %-formatting isn't dead yet and might pull through. 2013-05-23 00:12:14 -07:00
R David Murray 240a2fd46f #15575: Clarify tutorial description of when modules are executed. 2013-04-21 17:14:40 -04:00
Ezio Melotti 1b33206596 #13510: clarify that f.readlines() is note necessary to iterate over a file. Patch by Dan Riti. 2013-04-15 19:08:31 +03:00
Georg Brandl d4c45a91b7 Clarify that the function *definition* creates the function and the binding in the module globals. 2013-04-14 11:47:46 +02:00
Raymond Hettinger 4507274139 Modernize unittest example 2013-03-22 07:17:38 -07:00
Petri Lehtinen 0b785036ef Issue #8890: Stop advertising an insecure use of /tmp in docs 2013-02-23 19:24:31 +01:00
Andrew Svetlov bd5279ea24 Drop double newlines printed in some file iteration examples.
Patch by Steven Kryskalla.
2012-12-08 18:01:27 +02:00
Ezio Melotti 820f2bdaf9 Update section about dir() in the tutorial. 2012-11-17 12:46:40 +02:00
Ezio Melotti 9236a4e99d #16470: mention set and dict comprehension in the tutorial. Patch by Yongzhi Pan. 2012-11-17 12:02:30 +02:00
Georg Brandl 526b553608 Remove versionadded from the tutorial, at a location where it produces more questions than it answers. 2012-11-15 07:10:27 +01:00
Georg Brandl 8a0d58bb3d Use 2.x "print" syntax for this example. 2012-11-12 19:25:55 +01:00
Chris Jerdonek 8523db71d7 Backport from 3.2: improve FAQ link in documentation (for issue #16435). 2012-11-09 18:04:00 -08:00
Chris Jerdonek 64c0b2ca3d Backport from 3.2: remove "Release" and "Date" markers from index pages. 2012-10-28 11:16:36 -07:00
Jesus Cea 3dd8cbea9b Closes #16294: 8 space indent in tutorial 2012-10-22 13:14:20 +02:00
Chris Jerdonek 0cffd6be56 Issue #16225: Backport from 3.2: Add additional note to tutorial about looping. 2012-10-15 20:01:38 -07:00
Chris Jerdonek 3dec449a7c Issue #16015: Fix NameError doctest example in tutorial introduction. 2012-09-24 19:33:32 -07:00
Ezio Melotti 9c1c52b777 #16019, #16020: fix syntax highlight. 2012-09-24 17:30:39 +03:00
Ezio Melotti 4baf480088 #16017: capitalize URLs. 2012-09-24 17:06:11 +03:00
Eli Bendersky 2cc49745a5 Fix typo in tutorial 2012-08-18 09:51:37 +03:00
Sandro Tosi 6ce21a3b84 fix typo 2012-08-14 19:51:31 +02:00
Senthil Kumaran 2f76f73d73 Issue #15630: Add an example for "continue" statement in the tutorial. Patch by
Daniel Ellis.
2012-08-12 11:58:53 -07:00
Sandro Tosi 7687f3fb80 add missing period; thanks to Gaston Fiore from docs@ 2012-08-04 19:42:06 +02:00
Ezio Melotti f637920652 #14840: Add a bit on the difference between tuples and lists. Initial patch by Zachary Ware. 2012-06-17 14:10:59 +02:00
R David Murray 1eda5c9a83 #8652: update errors tutorial.
The tutorial had some outdated examples.  The patch also adds a caution
about the meaning of parens in the except statement.

Patch by Marien Zwart.
2012-06-07 21:46:44 -04:00
Nick Coghlan 0a09f3e2c3 Nudge readers towards a more accurate mental model for loop else clauses (Backport from 3.x) 2012-06-07 22:57:35 +10:00
Raymond Hettinger ce0e0c7671 Improve section heading for better discoverability. 2012-04-23 21:26:35 -07:00
Raymond Hettinger 4c8d392bc1 Reorder the entries to put the type specific technique last. 2012-04-23 21:24:15 -07:00
Sandro Tosi d53abd3154 Issue #11948: clarify modules search path 2012-01-19 11:28:15 +01:00
Sandro Tosi 98ed08f24e update to new C roles and directives 2012-01-14 16:42:02 +01:00
Terry Jan Reedy 477a06c142 Minor correction. Closes #11418 2012-01-11 14:51:07 -05:00
Georg Brandl 2c9eee1af9 I do not think we will ever have auto-indent at the prompt, that is for IPython and the like. 2011-12-25 19:03:07 +01:00
Ezio Melotti 05a7f0dcac #6570: clarify tutorial section about keyword arguments. 2011-12-13 15:49:22 +02:00
Ezio Melotti 4a72d1a661 #13549: improve tutorial section about listcomps. 2011-12-13 14:50:21 +02:00
Eli Bendersky ea4dcd33e5 remove duplicated paragraph in the tutorial 2011-11-16 05:54:07 +02:00
Sandro Tosi c93e413e31 remove confusing paragraph (as part of r87523); thanks to AJ Hill from docs@ 2011-10-31 17:15:03 +01:00
Senthil Kumaran 169fa9345d Doc fix. Mathematically correct sentence. 2011-09-29 07:52:46 +08:00
Éric Araujo afd2fe2aea Improve documentation for PEP 370 support in site module (#8617).
site.USER_BASE and site.USER_SITE are now fully documented.  PEP 370 is
outdated with respects to the Mac framework situation, but the code in
sysconfig and the example in the 3.2 What’s New document helped me find
the right values to document for Mac OS X.

The command-line interface of the site module is also described in the
module docs.

The purpose of the usercustomize module is explained in the site docs,
with a gentle introduction in the tutorial (right after the section that
talks about PYTHONSTARTUP; a comment mentions it should be moved from
the tutorial to another file, but that will be another bug).

Various markup and wording improvements were made along the way in the
site module docs.  Duplicate and incomplete declarations of environment
variables have also been removed (the original bug report was actually
about these entries :).  The site module docs are still a bit messy;
I’ll see about improving them for #11553.

All these sections are copiously interlinked and findable from the doc
indexes.
2011-08-19 08:20:01 +02:00
Georg Brandl a350f0f9fd Confirm that the prime example is actually correct. We get so many complaints about a "buggy example" on docs@python, let us hope this cuts them in half at least. 2011-08-08 21:45:13 +02:00
Éric Araujo 271208e225 Backout duplicate changeset ed34ca4e639c 2011-07-29 16:28:22 +02:00