3dec449a7c
Issue #16015 : Fix NameError doctest example in tutorial introduction.
2012-09-24 19:33:32 -07:00
9c1c52b777
#16019 , #16020 : fix syntax highlight.
2012-09-24 17:30:39 +03:00
4baf480088
#16017 : capitalize URLs.
2012-09-24 17:06:11 +03:00
2cc49745a5
Fix typo in tutorial
2012-08-18 09:51:37 +03:00
6ce21a3b84
fix typo
2012-08-14 19:51:31 +02:00
2f76f73d73
Issue #15630 : Add an example for "continue" statement in the tutorial. Patch by
...
Daniel Ellis.
2012-08-12 11:58:53 -07:00
7687f3fb80
add missing period; thanks to Gaston Fiore from docs@
2012-08-04 19:42:06 +02:00
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
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
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
ce0e0c7671
Improve section heading for better discoverability.
2012-04-23 21:26:35 -07:00
4c8d392bc1
Reorder the entries to put the type specific technique last.
2012-04-23 21:24:15 -07:00
d53abd3154
Issue #11948 : clarify modules search path
2012-01-19 11:28:15 +01:00
98ed08f24e
update to new C roles and directives
2012-01-14 16:42:02 +01:00
477a06c142
Minor correction. Closes #11418
2012-01-11 14:51:07 -05:00
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
05a7f0dcac
#6570 : clarify tutorial section about keyword arguments.
2011-12-13 15:49:22 +02:00
4a72d1a661
#13549 : improve tutorial section about listcomps.
2011-12-13 14:50:21 +02:00
ea4dcd33e5
remove duplicated paragraph in the tutorial
2011-11-16 05:54:07 +02:00
c93e413e31
remove confusing paragraph (as part of r87523); thanks to AJ Hill from docs@
2011-10-31 17:15:03 +01:00
169fa9345d
Doc fix. Mathematically correct sentence.
2011-09-29 07:52:46 +08:00
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
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
271208e225
Backout duplicate changeset ed34ca4e639c
2011-07-29 16:28:22 +02:00
b274586dd7
Add missing reST target to one heading in the tutorial
2011-06-11 10:34:19 +02:00
299172bdba
Make indentation comply with our style guide and the rest of the file
2011-07-26 16:54:24 +02:00
ec464cf9bb
Add missing reST target to one heading in the tutorial
2011-07-29 11:35:27 +02:00
fd1cb59618
Issue 12086: add example showing how to use name mangling.
2011-06-25 16:28:07 +02:00
832288ca18
merge 3.2 - Fix closes Issue12359 - Removing a confusing sentence from the previous change.
2011-06-20 07:34:48 -07:00
98fec3aa5e
Fix issue12359. Minor doc update on import module description.
2011-06-19 17:45:36 -07:00
bfbd1a2fd4
#12092 : backport rephrasing of a paragraph in the tutorial.
2011-05-17 05:39:22 +03:00
12b8fcfc45
Split combined code/doctest code blocks in two blocks, to enable proper highlighting.
2011-05-01 22:36:31 +02:00
10ab95a271
Remove untrue statement from tutorial
2011-03-26 01:26:08 +01:00
4fbd88a078
Fix typo spotted by Sandro Tosi
2011-03-22 21:45:42 +01:00
dd6833d20a
Fix markup in inputoutput.rst.
2011-03-13 02:13:08 +02:00
cdbc6967e8
#11405 : do not reference the string module again for its deprecated functions, only for Template class.
2011-03-06 10:56:18 +01:00
28dadd988b
Merged revisions 87050,87101,87146,87156,87172,87175,87371,87378,87522-87524,87526,87530-87535 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r87050 | georg.brandl | 2010-12-04 18:09:30 +0100 (Sa, 04 Dez 2010) | 1 line
Fix typo.
........
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.
........
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.
........
2011-02-25 10:50:32 +00:00
2bd4795e94
Issue #11304 : Input/output tutorial - PI is rounded not truncated.
2011-02-24 00:00:30 +00:00
561b96f98c
Merged revisions 86542,87136,87216,87221,87228,87256,87337-87338,87372,87516,87571,88164 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86542 | r.david.murray | 2010-11-19 22:48:58 -0500 (Fri, 19 Nov 2010) | 2 lines
Make test class name unique so that both test classes run.
........
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.
........
r87216 | r.david.murray | 2010-12-13 17:50:30 -0500 (Mon, 13 Dec 2010) | 2 lines
#10698 : fix typo in example.
........
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.
........
r87228 | r.david.murray | 2010-12-13 21:25:43 -0500 (Mon, 13 Dec 2010) | 2 lines
Turn on regrtest -W (rerun immediately) option for Windows, too.
........
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.
[changes to compileall.py were not backported, only the doc changes]
........
r87372 | r.david.murray | 2010-12-18 11:39:06 -0500 (Sat, 18 Dec 2010) | 2 lines
#10728 : the default for printing help is sys.stdout, not stderr.
........
r87516 | r.david.murray | 2010-12-27 15:09:32 -0500 (Mon, 27 Dec 2010) | 5 lines
#7056 : runtest and runtest_inner don't use testdir, so drop it from their sigs
I've only tested regular runs and -j runs. If I've broken anything
else I'm sure I'll hear about it sooner or later.
........
r87571 | r.david.murray | 2010-12-29 14:06:48 -0500 (Wed, 29 Dec 2010) | 2 lines
Fix same typo in docs.
........
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 17:25:54 +00:00
86fed7d3a6
Merged revisions 86794,86798,86801 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86794 | georg.brandl | 2010-11-26 12:50:13 +0100 (Fr, 26 Nov 2010) | 1 line
#10526 : fix typo.
........
r86798 | georg.brandl | 2010-11-26 13:05:48 +0100 (Fr, 26 Nov 2010) | 1 line
#10420 : fix docs of bdb.effective().
........
r86801 | georg.brandl | 2010-11-26 13:12:14 +0100 (Fr, 26 Nov 2010) | 1 line
Better example for os.system(): do not change the system time.
........
2010-11-26 18:26:04 +00:00
b8d0e365e2
Merged revisions 85617-85622,85624,85626-85627,85629,85631,85635-85636,85638-85639,85641-85642 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r85617 | georg.brandl | 2010-10-17 12:09:06 +0200 (So, 17 Okt 2010) | 1 line
#5212 : md5 weaknesses do not affect hmac, so remove the note about that.
........
r85618 | georg.brandl | 2010-10-17 12:14:38 +0200 (So, 17 Okt 2010) | 1 line
#9086 : correct wrong terminology about linking with pythonXY.dll.
........
r85619 | georg.brandl | 2010-10-17 12:15:50 +0200 (So, 17 Okt 2010) | 1 line
Make file names consistent.
........
r85620 | georg.brandl | 2010-10-17 12:22:28 +0200 (So, 17 Okt 2010) | 1 line
Remove second parser module example; it referred to non-readily-available example files, and this kind of discovery is much better done with the AST nowadays anyway.
........
r85621 | georg.brandl | 2010-10-17 12:24:54 +0200 (So, 17 Okt 2010) | 1 line
#9105 : move pickle warning to a bit more prominent location.
........
r85622 | georg.brandl | 2010-10-17 12:28:04 +0200 (So, 17 Okt 2010) | 1 line
#9112 : document error() and exit() methods of ArgumentParser.
........
r85624 | georg.brandl | 2010-10-17 12:34:28 +0200 (So, 17 Okt 2010) | 1 line
Some markup and style fixes in argparse docs.
........
r85626 | georg.brandl | 2010-10-17 12:38:20 +0200 (So, 17 Okt 2010) | 1 line
#9117 : fix syntax for class definition.
........
r85627 | georg.brandl | 2010-10-17 12:44:11 +0200 (So, 17 Okt 2010) | 1 line
#9138 : reword introduction to classes in Python.
........
r85629 | georg.brandl | 2010-10-17 12:51:45 +0200 (So, 17 Okt 2010) | 1 line
#5962 : clarify sys.exit() vs. threads.
........
r85631 | georg.brandl | 2010-10-17 12:53:54 +0200 (So, 17 Okt 2010) | 1 line
Fix capitalization.
........
r85635 | georg.brandl | 2010-10-17 13:03:22 +0200 (So, 17 Okt 2010) | 1 line
#5121 : fix claims about default values leading to segfaults.
........
r85636 | georg.brandl | 2010-10-17 13:06:14 +0200 (So, 17 Okt 2010) | 1 line
#9237 : document sys.call_tracing().
........
r85638 | georg.brandl | 2010-10-17 13:13:37 +0200 (So, 17 Okt 2010) | 1 line
Port changes to pickle docs apparently lost in py3k.
........
r85639 | georg.brandl | 2010-10-17 13:23:56 +0200 (So, 17 Okt 2010) | 1 line
Make twisted example a bit more logical.
........
r85641 | georg.brandl | 2010-10-17 13:29:07 +0200 (So, 17 Okt 2010) | 1 line
Fix documentation of dis.opmap direction.
........
r85642 | georg.brandl | 2010-10-17 13:36:28 +0200 (So, 17 Okt 2010) | 1 line
#9730 : fix example.
........
2010-11-26 07:53:50 +00:00
78f11edf3f
Merged revisions 85530,85534,85538,85540-85542 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r85530 | georg.brandl | 2010-10-15 17:32:05 +0200 (Fr, 15 Okt 2010) | 1 line
Refrain from using inline suites.
........
r85534 | georg.brandl | 2010-10-15 18:19:43 +0200 (Fr, 15 Okt 2010) | 1 line
#9801 : document how list and dict proxies created by Managers behave w.r.t. mutable items.
........
r85538 | georg.brandl | 2010-10-15 18:35:46 +0200 (Fr, 15 Okt 2010) | 1 line
#7303 : add documentation for useful pkgutil functions and classes.
........
r85540 | georg.brandl | 2010-10-15 18:42:37 +0200 (Fr, 15 Okt 2010) | 1 line
#6798 : fix wrong docs for the arguments to several trace events.
........
r85541 | georg.brandl | 2010-10-15 18:53:24 +0200 (Fr, 15 Okt 2010) | 1 line
#4968 : updates to inspect.is* function docs.
........
r85542 | georg.brandl | 2010-10-15 19:01:15 +0200 (Fr, 15 Okt 2010) | 1 line
#7790 : move table of struct_time members to the actual description of struct_time.
........
2010-11-26 07:34:20 +00:00
bf02429c43
Merged revisions 86310 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86310 | senthil.kumaran | 2010-11-08 09:53:13 +0800 (Mon, 08 Nov 2010) | 3 lines
Fix Issue 10303: a small clarification in the tutorial.
........
2010-11-08 02:12:57 +00:00
fc3901e5bf
Clarify.
2010-11-05 07:38:48 +00:00
44c3ceb8ac
#8267 : Use sorted() to get a sorted list of dict keys.
2010-10-15 15:31:09 +00:00
33e5935b53
More tweaks to floating-point section of the tutorial.
2010-08-04 21:44:47 +00:00
7d4bfb338d
Merged revisions 83536,83546-83548,83550,83554-83555,83558,83563,83565,83571,83574-83575 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r83536 | georg.brandl | 2010-08-02 19:49:25 +0200 (Mo, 02 Aug 2010) | 1 line
#8578 : mention danger of not incref'ing weak referenced object.
........
r83546 | georg.brandl | 2010-08-02 21:16:34 +0200 (Mo, 02 Aug 2010) | 1 line
#7973 : Fix distutils options spelling.
........
r83547 | georg.brandl | 2010-08-02 21:19:26 +0200 (Mo, 02 Aug 2010) | 1 line
#7386 : add example that shows that trailing path separators are stripped.
........
r83548 | georg.brandl | 2010-08-02 21:23:34 +0200 (Mo, 02 Aug 2010) | 1 line
#8172 : how does one use a property?
........
r83550 | georg.brandl | 2010-08-02 21:32:43 +0200 (Mo, 02 Aug 2010) | 1 line
#9451 : strengthen warning about __*__ special name usage.
........
r83554 | georg.brandl | 2010-08-02 21:43:05 +0200 (Mo, 02 Aug 2010) | 1 line
#7280 : note about nasmw.exe.
........
r83555 | georg.brandl | 2010-08-02 21:44:48 +0200 (Mo, 02 Aug 2010) | 1 line
#8861 : remove unused variable.
........
r83558 | georg.brandl | 2010-08-02 22:05:19 +0200 (Mo, 02 Aug 2010) | 1 line
#8648 : document UTF-7 codec functions.
........
r83563 | georg.brandl | 2010-08-02 22:21:21 +0200 (Mo, 02 Aug 2010) | 1 line
#9037 : add example how to raise custom exceptions from C code.
........
r83565 | georg.brandl | 2010-08-02 22:27:20 +0200 (Mo, 02 Aug 2010) | 1 line
#9111 : document that do_help() looks at docstrings.
........
r83571 | georg.brandl | 2010-08-02 22:44:34 +0200 (Mo, 02 Aug 2010) | 1 line
Clarify that abs() is not a namespace.
........
r83574 | georg.brandl | 2010-08-02 22:47:56 +0200 (Mo, 02 Aug 2010) | 1 line
#6867 : epoll.register() returns None.
........
r83575 | georg.brandl | 2010-08-02 22:52:10 +0200 (Mo, 02 Aug 2010) | 1 line
#9238 : zipfile does handle archive comments.
........
2010-08-02 21:44:25 +00:00
2c10840e2c
Merged revisions 82965 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r82965 | georg.brandl | 2010-07-19 13:28:05 +0200 (Mo, 19 Jul 2010) | 1 line
Clarification. Yay importlib!
........
2010-08-01 21:28:47 +00:00
d5d3256cac
Update the floating-point section of the tutorial for the short float repr.
2010-07-30 12:58:44 +00:00
565569b8dc
Confusing punctuation.
2010-06-27 10:47:47 +00:00
Chris Jerdonek
Ezio Melotti
Eli Bendersky
Sandro Tosi
Senthil Kumaran
R David Murray
Nick Coghlan
Raymond Hettinger
Terry Jan Reedy
Georg Brandl
Éric Araujo
Senthil Kumaran
Mark Dickinson