88fc66179b
Cleanup example
2011-06-01 16:01:21 -07:00
690d4ae8bf
Multiple clean-ups to the docs for builtin functions.
...
* Use concrete example for dir() and eliminate the distracting doctest directives.
* Add a pure python equivalent for enumerate()
* Modify the enumerate() example to demonstrate the start argument
* Remove incorrect reference the *iterable* in the enumerate() docs.
* Downgrade the comments on input() from a warning to a note.
* Fix the iter() example to use the empty string as the terminating
condition for file.readline(). Also, the old example was broken
because readline() results include a newline, so 'STOP\n' would have
been the correct terminating condition. Even with that fix, the
STOP example was fragile and would have lead to infinite loops with
malformed inputs.
* Do not refer to classmethod as being "more advanced" than staticmethod.
2011-06-01 15:50:34 -07:00
783a30f38e
Link to suggestions for how to use super().
2011-06-01 14:57:13 -07:00
29f6efa844
Issue 12003: fixing error in xrange alternative sample
2011-05-23 06:10:26 +03:00
26946ecaed
Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r85548 | georg.brandl | 2010-10-15 21:46:19 +0200 (Fr, 15 Okt 2010) | 1 line
#10072 : assume a bit less knowledge of the FTP protocol in the ftplib docs.
........
r85572 | georg.brandl | 2010-10-16 20:51:05 +0200 (Sa, 16 Okt 2010) | 1 line
#10122 : typo fix.
........
r85573 | georg.brandl | 2010-10-16 20:53:08 +0200 (Sa, 16 Okt 2010) | 1 line
#10124 : typo fix.
........
r85606 | georg.brandl | 2010-10-17 08:32:59 +0200 (So, 17 Okt 2010) | 1 line
#10058 : tweak wording about exception returns.
........
r85609 | georg.brandl | 2010-10-17 11:19:03 +0200 (So, 17 Okt 2010) | 1 line
#8556 : use less confusing mapping key in example.
........
r85610 | georg.brandl | 2010-10-17 11:23:05 +0200 (So, 17 Okt 2010) | 1 line
#8686 : remove potentially confusing wording that does not add any value.
........
r85611 | georg.brandl | 2010-10-17 11:33:24 +0200 (So, 17 Okt 2010) | 1 line
#8811 : small fixes to sqlite3 docs.
........
r85612 | georg.brandl | 2010-10-17 11:37:54 +0200 (So, 17 Okt 2010) | 1 line
#8855 : add shelve security warning.
........
r85614 | georg.brandl | 2010-10-17 11:46:11 +0200 (So, 17 Okt 2010) | 1 line
#8968 : add actual name of token constants.
........
r85615 | georg.brandl | 2010-10-17 12:05:13 +0200 (So, 17 Okt 2010) | 1 line
#459007 : merge info from PC/getpathp.c and using/windows.rst to document the forming of sys.path under Windows.
........
r85616 | georg.brandl | 2010-10-17 12:07:29 +0200 (So, 17 Okt 2010) | 1 line
Fix copy-paste error in example.
........
2010-11-26 07:42:15 +00:00
bf8484e77d
Merged revisions 86732 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86732 | ezio.melotti | 2010-11-24 22:18:02 +0200 (Wed, 24 Nov 2010) | 1 line
#10299 : Add a table that lists all the built-in functions in functions.rst
........
2010-11-24 21:54:47 +00:00
e8803e7524
Issue #8340 : document bytearray in Python 2.7.
2010-11-20 19:35:42 +00:00
d5cd1ff7da
Merged revisions 86249 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86249 | eric.araujo | 2010-11-06 07:30:16 +0100 (sam., 06 nov. 2010) | 2 lines
Fix typo
........
2010-11-06 06:31:54 +00:00
15c2cec4fd
Issue 7447: Improve docs for sum().
2010-10-31 21:28:53 +00:00
21946afe3f
Merged revisions 82798,82805,83659,83977,84015,84018,84141,84264,84326-84327,84480,84482,84484,84530-84531,84553,84619,84915-84916 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r82798 | georg.brandl | 2010-07-11 11:23:11 +0200 (So, 11 Jul 2010) | 1 line
#6774 : explain shutdown() behavior varying with platform.
........
r82805 | georg.brandl | 2010-07-11 11:42:10 +0200 (So, 11 Jul 2010) | 1 line
#7935 : cross-reference to ast.literal_eval() from eval() docs.
........
r83659 | georg.brandl | 2010-08-03 14:06:29 +0200 (Di, 03 Aug 2010) | 1 line
Terminology fix: exceptions are raised, except in generator.throw().
........
r83977 | georg.brandl | 2010-08-13 17:10:49 +0200 (Fr, 13 Aug 2010) | 1 line
Fix copy-paste error.
........
r84015 | georg.brandl | 2010-08-14 17:44:34 +0200 (Sa, 14 Aug 2010) | 1 line
Add some maintainers.
........
r84018 | georg.brandl | 2010-08-14 17:48:49 +0200 (Sa, 14 Aug 2010) | 1 line
Typo fix.
........
r84141 | georg.brandl | 2010-08-17 16:11:59 +0200 (Di, 17 Aug 2010) | 1 line
Markup nits.
........
r84264 | georg.brandl | 2010-08-22 22:23:38 +0200 (So, 22 Aug 2010) | 1 line
#9649 : fix default value description.
........
r84326 | georg.brandl | 2010-08-26 16:30:15 +0200 (Do, 26 Aug 2010) | 1 line
#9689 : add links from overview to in-depth class API descriptions.
........
r84327 | georg.brandl | 2010-08-26 16:30:56 +0200 (Do, 26 Aug 2010) | 1 line
#9681 : typo.
........
r84480 | georg.brandl | 2010-09-04 00:33:27 +0200 (Sa, 04 Sep 2010) | 1 line
More inclusive title.
........
r84482 | georg.brandl | 2010-09-04 00:40:02 +0200 (Sa, 04 Sep 2010) | 1 line
#9760 : clarify what context expression is.
........
r84484 | georg.brandl | 2010-09-04 00:49:27 +0200 (Sa, 04 Sep 2010) | 1 line
Fix missing word.
........
r84530 | georg.brandl | 2010-09-05 19:07:12 +0200 (So, 05 Sep 2010) | 1 line
#9747 : fix copy-paste error in getresgid() doc.
........
r84531 | georg.brandl | 2010-09-05 19:09:18 +0200 (So, 05 Sep 2010) | 1 line
#9776 : fix some spacing.
........
r84553 | georg.brandl | 2010-09-06 08:49:07 +0200 (Mo, 06 Sep 2010) | 1 line
#9780 : both { and } are not valid fill characters.
........
r84619 | georg.brandl | 2010-09-08 12:43:45 +0200 (Mi, 08 Sep 2010) | 1 line
Add Lukasz.
........
r84915 | georg.brandl | 2010-09-20 08:27:02 +0200 (Mo, 20 Sep 2010) | 1 line
Fix typo.
........
r84916 | georg.brandl | 2010-09-20 08:29:01 +0200 (Mo, 20 Sep 2010) | 1 line
Mention % as string formatting.
........
2010-10-06 09:28:45 +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
19746cb322
Merged revisions 83277 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r83277 | mark.dickinson | 2010-07-30 14:13:02 +0100 (Fri, 30 Jul 2010) | 1 line
Add note about surprising behaviour from round function.
........
2010-07-30 13:16:07 +00:00
5ac9d87628
#8472 : fix misleading reference to ifilterfalse() in filter() docs.
2010-07-04 17:28:33 +00:00
8c09ebcf0c
#8472 : fix wrong function name in functions.rst: itertools.filterfalse -> itertools.ifilterfalse
2010-04-20 16:49:48 +00:00
c9a8a4aab8
#8370 : fix module name in backported doc addition.
2010-04-14 21:36:49 +00:00
bb006cf26c
Add tests for cmp_to_key.
...
Adopt PEP 8 compliant function name.
Factor-out existing uses cmp_to_key.
Update documentation to use internal pointers instead of external resource.
2010-04-04 21:45:01 +00:00
f54c268326
Document link to Sorting HowTo
2010-04-01 07:54:16 +00:00
118c55778e
Fix some issues found by Jacques Ducasse on the docs list.
2010-03-21 09:01:27 +00:00
2600a33219
#7400 : typo.
2009-11-26 20:48:25 +00:00
b6fb8dcbce
Fix terminology.
2009-11-14 11:50:51 +00:00
2fb77bd6f5
revert r76243; I was right, actually :)
2009-11-13 22:56:00 +00:00
c4a346cc55
never mind about eval mode in this case
2009-11-13 22:17:17 +00:00
e36199b49d
fix several compile() issues by translating newlines in the tokenizer
2009-11-12 23:39:44 +00:00
6c14e587f5
Use "impl-detail" directive where applicable.
2009-10-22 11:48:10 +00:00
530df33eac
Issue #7028 : Add note to hex() builtin docs pointing to float.hex().
2009-10-03 10:14:34 +00:00
54967d994a
#6925 : rewrite docs for locals() and vars() a bit.
2009-09-18 21:21:41 +00:00
29bc2cd463
Fix base keyword arg name for int() and long().
2009-08-06 15:06:25 +00:00
d7d4fd7336
builtin -> built-in.
2009-07-26 14:37:28 +00:00
9fa61bb37d
#6577 : fix (hopefully) all links to builtin instead of module/class-specific objects.
2009-07-26 14:19:57 +00:00
4ee6d25b18
Improve English phrasing.
2009-06-22 22:11:04 +00:00
e15048ea37
s/use/call/
2009-05-22 09:50:30 +00:00
22396da5ee
Fix confusing wording.
2009-05-22 09:49:42 +00:00
fa0123b4fa
#6084 : fix example.
2009-05-22 09:33:25 +00:00
16a57f6a34
Demote warnings to notices where appropriate, following the goal that as few "red box" warnings
...
should clutter the docs as possible. Part 1: stuff that gets merged to Py3k.
2009-04-27 15:29:09 +00:00
e56101136c
#5751 : fix escaping of \\n.
2009-04-21 18:24:34 +00:00
76162e305c
Clarify the behavior of any() and all() with an empty iterable.
2009-04-16 18:16:10 +00:00
789be0c0a0
Issue #2396 : backport the memoryview object.
2009-04-02 21:18:34 +00:00
d59efbccf1
#5199 : make warning about vars() assignment more visible.
2009-03-30 22:09:34 +00:00
06919a177d
a much better example
2009-03-18 20:58:09 +00:00
ed3558b334
I thought this was begging for an example
2009-03-17 20:29:51 +00:00
ed955f108f
Fix typo.
2009-02-26 00:05:24 +00:00
afe496dc46
Remove reference to zero argument form of super() in 2.x docs.
2009-02-25 01:06:52 +00:00
b762d58544
More markup and spelling fixes.
2009-02-25 00:52:37 +00:00
eb7cbb94c5
Restore Py2.x version of sample call to super().
2009-02-25 00:39:47 +00:00
9766033b7c
Sync-up py3.1 doc updates for super().
2009-02-25 00:37:57 +00:00
528f8810aa
#5348 : format() converts all kinds of values.
2009-02-23 10:24:23 +00:00
749e6d0a01
Add links to helpful external resources.
2009-02-19 06:55:03 +00:00
f9bce83e71
Add some cross-references to the docs. Simplify the python code equivalent for izip(). Supply an optional argument for the nth() recipe.
2009-02-19 05:34:35 +00:00
7c98a6d4dc
Add explanation for super(type1, type2).
2009-02-16 23:00:25 +00:00
fd04870a3d
Issue 5229: Documentation for super() neglects to say what super() actually does
2009-02-16 22:42:54 +00:00
Raymond Hettinger
Eli Bendersky
Georg Brandl
Ezio Melotti
Antoine Pitrou
Éric Araujo
Mark Dickinson
Benjamin Peterson
R. David Murray