Commit Graph

248 Commits

Author SHA1 Message Date
Andrew Svetlov 1491cbdf63 Issue #14893: Add function annotation example to function tutorial.
Patch by Zachary Ware.
2012-11-01 21:26:55 +02:00
Chris Jerdonek 8b7f9f581d Remove unneeded "Release" and "Date" markers from doc index pages. 2012-10-28 11:08:26 -07:00
Jesus Cea af38774b5f Closes #16294: 8 space indent in tutorial 2012-10-22 13:15:17 +02:00
Chris Jerdonek 5bf7f1f6e3 Clarify universal-newline wording in tutorial (issue #16266). 2012-10-17 20:17:41 -07:00
Andrew Svetlov e9cf97cf20 Issue #16265: Fix collapsing of code sample in tutorial.
Thanks to Yongzhi Pan from docs@
2012-10-17 16:41:28 +03:00
Chris Jerdonek 4fab8f0e06 Issue #16225: Add additional note to tutorial about changing sequence while looping. 2012-10-15 19:44:47 -07:00
Ezio Melotti 7fa822275b Fix links to the __next__ method. 2012-10-12 13:42:08 +03:00
Chris Jerdonek fd448daf77 Close issue #16073: fix map() example in list comprehension documentation.
Thanks for the e-mail report to docs@.
2012-09-28 07:07:12 -07:00
Chris Jerdonek df12f2bbb6 Issue #16015: Make welcome message more realistic in tutorial example. 2012-09-25 04:20:29 -07:00
Chris Jerdonek 9bb56a66c5 Issue #16015: Fix NameError doctest example in tutorial introduction. 2012-09-24 19:28:59 -07:00
Ezio Melotti 8618fb6a65 #16019, #16020: fix syntax highlight. 2012-09-24 17:30:39 +03:00
Ezio Melotti c926c59d80 #16017: capitalize URLs. 2012-09-24 17:07:39 +03:00
Eli Bendersky 31a11902b3 tutorial typo fix 2012-08-18 09:50:09 +03:00
Sandro Tosi a17ef14632 fix typo 2012-08-14 19:51:43 +02:00
Senthil Kumaran 1ef9caa2a1 Issue #15630: Add an example for "continue" statement in the tutorial. Patch by
Daniel Ellis.
2012-08-12 12:01:47 -07:00
Sandro Tosi 0a90a82b8a zip() returns an iterator, make a list() of it; thanks to Martin from docs@ 2012-08-12 10:24:50 +02:00
Antoine Pitrou fbd4f80979 Issue #15444: Use proper spelling for non-ASCII contributor names.
Patch by Serhiy Storchaka.
2012-08-11 16:51:50 +02:00
Sandro Tosi da9df92068 add missing period; thanks to Gaston Fiore from docs@ 2012-08-04 19:42:24 +02:00
Ezio Melotti f90ea1f0a0 #14840: Add a bit on the difference between tuples and lists. Initial patch by Zachary Ware. 2012-06-17 14:10:59 +02:00
Nick Coghlan a3a164a03c Nudge readers towards a more accurate mental model for loop else clauses 2012-06-07 22:41:34 +10:00
Senthil Kumaran 065dedaf47 Fix closes Issue: 14217 - 3.2 branch 2012-03-08 20:56:52 -08:00
Sandro Tosi f0229aa51c Issue #11948: clarify modules search path 2012-01-19 11:29:26 +01:00
Terry Jan Reedy ea868d32a1 Minor correction. #11418 2012-01-11 14:54:34 -05:00
Georg Brandl 1532c8f9a7 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 7b7e39a61f #6570: clarify tutorial section about keyword arguments. 2011-12-13 15:49:22 +02:00
Ezio Melotti 91621e2c16 #13549: improve tutorial section about listcomps. 2011-12-13 15:36:19 +02:00
Sandro Tosi 69e59a17dd remove confusing paragraph (as part of r87523); thanks to AJ Hill from docs@ 2011-10-31 17:15:39 +01:00
Ezio Melotti e130a52d8a Remove duplication. 2011-10-19 10:58:56 +03:00
Éric Araujo da3f4ae34b Branch merge 2011-08-09 18:01:38 +02:00
Georg Brandl bdbdfb1978 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 de4f05b741 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, partly documented in the
3.2 What’s New, is fully 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-06 01:51:07 +02:00
Éric Araujo 72db3459e4 Make indentation comply with our style guide and the rest of the file 2011-07-26 16:54:24 +02:00
Raymond Hettinger 6ddefd7916 Issue 12086: add example showing how to use name mangling. 2011-06-25 16:30:39 +02:00
Senthil Kumaran 4707a998e4 Fix closes Issue12359 - Removing a confusing sentence from the previous change. 2011-06-20 07:30:34 -07:00
Senthil Kumaran 150857028c minor space nit. 2011-06-19 17:41:33 -07:00
Senthil Kumaran 5c0347b398 Fix closes Issue12359 - Minor update to module import description. 2011-06-19 17:37:06 -07:00
Éric Araujo 9fbfe15c86 Add missing reST target to one heading in the tutorial 2011-06-11 10:34:19 +02:00
Georg Brandl da623ed9f4 Split combined code/doctest code blocks in two blocks, to enable proper highlighting. 2011-05-01 22:37:23 +02:00
Éric Araujo 722bec4210 Merge 3.1 2011-03-26 01:59:47 +01:00
Éric Araujo a464d4e608 Remove untrue statement from tutorial 2011-03-25 21:53:58 +01:00
Ezio Melotti 0def5c6907 Merge with 3.1. 2011-03-13 02:27:26 +02:00
Ezio Melotti 2b73660135 Fix markup in inputoutput.rst. 2011-03-13 02:19:57 +02:00
Georg Brandl 891391bf68 Merge doc fixes. 2011-03-06 11:12:42 +01:00
Georg Brandl 3640e18d90 #11405: do not reference the string module again for its deprecated functions, only for Template class. 2011-03-06 10:56:18 +01:00
Georg Brandl d98934c483 Merged revisions 87101,87146,87156,87172,87175,87371,87378,87522-87524,87526-87528,87530-87536,87581 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

........
  r87101 | georg.brandl | 2010-12-06 23:02:48 +0100 (Mo, 06 Dez 2010) | 1 line

  Remove visible XXX comments.
........
  r87146 | georg.brandl | 2010-12-09 19:08:43 +0100 (Do, 09 Dez 2010) | 1 line

  Fix "seperate".
........
  r87156 | georg.brandl | 2010-12-10 11:01:44 +0100 (Fr, 10 Dez 2010) | 1 line

  #10668: fix wrong call of __init__.
........
  r87172 | georg.brandl | 2010-12-11 20:10:30 +0100 (Sa, 11 Dez 2010) | 1 line

  Avoid AttributeError(_closed) when a TemporaryDirectory is deallocated whose mkdtemp call failed.
........
  r87175 | georg.brandl | 2010-12-11 23:19:34 +0100 (Sa, 11 Dez 2010) | 1 line

  Fix markup.
........
  r87371 | georg.brandl | 2010-12-18 17:21:58 +0100 (Sa, 18 Dez 2010) | 1 line

  Fix typo.
........
  r87378 | georg.brandl | 2010-12-18 18:51:28 +0100 (Sa, 18 Dez 2010) | 1 line

  #10723: add missing builtin exceptions.
........
  r87522 | georg.brandl | 2010-12-28 10:16:12 +0100 (Di, 28 Dez 2010) | 1 line

  Replace sys.maxint mention by sys.maxsize.
........
  r87523 | georg.brandl | 2010-12-28 10:18:24 +0100 (Di, 28 Dez 2010) | 1 line

  Remove confusing paragraph -- this is relevant only to advanced users anyway and does not belong into the tutorial.
........
  r87524 | georg.brandl | 2010-12-28 10:29:19 +0100 (Di, 28 Dez 2010) | 1 line

  Fix advice: call PyType_Ready to fill in ob_type of custom types.
........
  r87526 | georg.brandl | 2010-12-28 11:38:33 +0100 (Di, 28 Dez 2010) | 1 line

  #10777: fix iteration over dict keys while mutating the dict.
........
  r87527 | georg.brandl | 2010-12-28 11:56:20 +0100 (Di, 28 Dez 2010) | 1 line

  #10768: fix ScrolledText widget construction, and make the example work from the interactive shell.
........
  r87528 | georg.brandl | 2010-12-28 12:02:12 +0100 (Di, 28 Dez 2010) | 1 line

  Add news entry and clarify another.
........
  r87530 | georg.brandl | 2010-12-28 12:06:07 +0100 (Di, 28 Dez 2010) | 1 line

  #10767: update README in crashers; not all may have a bug entry and/or be fixed.
........
  r87531 | georg.brandl | 2010-12-28 12:08:17 +0100 (Di, 28 Dez 2010) | 1 line

  #10742: document readonly attribute of memoryviews.
........
  r87532 | georg.brandl | 2010-12-28 12:15:49 +0100 (Di, 28 Dez 2010) | 1 line

  #10781: clarify that *encoding* is not a parameter for Node objects in general.
........
  r87533 | georg.brandl | 2010-12-28 12:38:12 +0100 (Di, 28 Dez 2010) | 1 line

  Remove history; adapt a bit more to reST, since this will once be part of the dev guide.
........
  r87534 | georg.brandl | 2010-12-28 12:48:53 +0100 (Di, 28 Dez 2010) | 1 line

  Rewrap.
........
  r87535 | georg.brandl | 2010-12-28 12:49:41 +0100 (Di, 28 Dez 2010) | 1 line

  #10739: document that on Windows, socket.makefile() does not make a file that has a true file descriptor usable where such a thing is expected.
........
  r87536 | georg.brandl | 2010-12-28 12:53:25 +0100 (Di, 28 Dez 2010) | 1 line

  #10609: fix non-working dbm example.
........
  r87581 | georg.brandl | 2010-12-30 18:36:17 +0100 (Do, 30 Dez 2010) | 1 line

  Fix NameErrors.
........
2011-02-25 10:03:34 +00:00
Raymond Hettinger 756fe2608d Issue #11304: Input/output tutorial - PI is rounded not truncated. 2011-02-24 00:06:16 +00:00
R. David Murray 43b2f457a0 Merged revisions 87136,87221,87256,87337-87338,87571,87839,88164 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k


........
  r87136 | r.david.murray | 2010-12-08 17:53:00 -0500 (Wed, 08 Dec 2010) | 6 lines

  Have script_helper._assert_python strip refcount strings from stderr.

  This makes the output of the function and those that depend on it
  independent of whether or not they are being run under a debug
  build.
........
  r87221 | r.david.murray | 2010-12-13 19:55:46 -0500 (Mon, 13 Dec 2010) | 4 lines

  #10699: fix docstring for tzset: it does not take a parameter

  Thanks to Garrett Cooper for the fix.
........
  r87256 | r.david.murray | 2010-12-14 21:19:14 -0500 (Tue, 14 Dec 2010) | 2 lines

  #10705: document what the values of debuglevel are and mean.
........
  r87337 | r.david.murray | 2010-12-17 11:11:40 -0500 (Fri, 17 Dec 2010) | 2 lines

  #10559: provide instructions for accessing sys.argv when first mentioned.
........
  r87338 | r.david.murray | 2010-12-17 11:29:07 -0500 (Fri, 17 Dec 2010) | 2 lines

  #10454: clarify the compileall docs and help messages.
    [compileall.py changes not backported.]
........
  r87571 | r.david.murray | 2010-12-29 14:06:48 -0500 (Wed, 29 Dec 2010) | 2 lines

  Fix same typo in docs.
........
  r87839 | r.david.murray | 2011-01-07 16:57:25 -0500 (Fri, 07 Jan 2011) | 9 lines

  Fix formatting of values with embedded newlines when rfc2047 encoding

  Before this patch if a value being encoded had an embedded newline,
  the line following the newline would have no leading whitespace,
  and the whitespace it did have was encoded into the word.  Now
  the existing whitespace gets turned into a blank, the way it does
  in other header reformatting, and the _continuation_ws gets added
  at the beginning of the encoded line.
........
  r88164 | r.david.murray | 2011-01-24 14:34:58 -0500 (Mon, 24 Jan 2011) | 12 lines

  #10960: fix 'stat' links, link to lstat from stat, general tidy of stat doc.

  Original patch by Michal Nowikowski, with some additions and wording
  fixes by me.

  I changed the wording from 'Performs a stat system call' to 'Performs
  the equivalent of a stat system call', since on Windows there are no
  stat/lstat system calls involved.  I also extended Michal's breakout
  of the attributes into a list to the other paragraphs, and rearranged
  the order of the paragraphs in the 'stat' docs to make it flow
  better and put it in what I think is a more logical/useful order.
........
2011-02-11 03:13:19 +00:00
Georg Brandl 6d6fa47fb0 Merged revisions 86882 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

........
  r86882 | georg.brandl | 2010-11-30 09:20:16 +0100 (Di, 30 Nov 2010) | 1 line

  Fix input type for zlib.
........
2011-01-08 09:18:55 +00:00
Georg Brandl fcf3a0c55b Remove confusing paragraph -- this is relevant only to advanced users anyway and does not belong into the tutorial. 2010-12-28 09:18:24 +00:00
R. David Murray a396463db3 #10559: provide instructions for accessing sys.argv when first mentioned. 2010-12-17 16:11:40 +00:00