Commit Graph

213 Commits

Author SHA1 Message Date
Andrew M. Kuchling e7bd876f9d Message for NameError has changed 2002-05-02 14:31:55 +00:00
Fred Drake 38f71973e5 Documentation for the enumerate() function/type.
This closes SF patch #547162.
2002-04-26 20:29:44 +00:00
Fred Drake 6cb64f9e46 "Shortcut" should be "short-circuit".
This closes SF bug #526277.
2002-03-08 00:54:43 +00:00
Fred Drake c26467d53f Revise cheeseshop example so that the order of the keyword output is
completely determined by the example; dict insertion order and the string
hash algorithm no longer affect the output.
This fixes SF bug #509281.
2002-01-29 14:53:30 +00:00
Fred Drake 23d45f4744 Fix up some examples in the tutorial so we don't contradict our own
advice on docstrings.
This fixes SF bug #495601.
2001-12-20 23:54:56 +00:00
Fred Drake ecd8157a2c Include a warning that scripts should not have the same name as standard
modules, or the module cannot be properly imported.  (Based on a suggestion
sent to python-docs.)

Update the displayed dir() of the sys and __builtin__ module with Python 2.2.
2001-12-04 19:47:46 +00:00
Fred Drake 6016dbecca Talk about str() in the discussion of string representations of values, and
give examples for which str() and repr() yield different results.
This closes SF bug #485446.
2001-12-04 19:20:43 +00:00
Fred Drake fcf94681ed Update lambda description to reflect nested scopes. This was noted by
Andrew Koenig.
2001-12-03 21:47:37 +00:00
Fred Drake 1da50f6c6e Add a scalar product to the example list comprehensions based on a suggestion
sent to python-docs.
2001-12-03 18:54:33 +00:00
Fred Drake c37b65ee10 Clean up some markup cruft. A number of the macros that take no
parameters (like \UNIX) are commonly entered using an empty group to
separate the markup from a following inter-word space; this is not
needed when the next character is punctuation, or the markup is the
last thing in the enclosing group.  These cases were marked
inconsistently; the empty group is now *only* used when needed.
2001-11-28 07:26:15 +00:00
Fred Drake a815916472 Fix thinko in a comment about seeking with a file object.
Reported by Francesco Trentini.
2001-10-16 03:25:00 +00:00
Fred Drake 13af42822c Exceptions in interactive examlpes did not always include the indication of
the source file using "in ?".

Added a description of the bare "raise" statement.

Added more description and examples for user-defined exceptions; this
is part of a response to SF bug #443559.
2001-09-21 21:10:05 +00:00
Fred Drake ba5c41d4c5 Clarified the interaction between string literals and continuation lines.
Fixes bug reported as SF bug #453728.
2001-09-06 18:41:15 +00:00
Fred Drake 8b09f4985c Make the examples for "Default Argument Values" more presentable and
less hostile to newbie use at the interactive prompt.
This is in response to SF bug #458654.
2001-09-06 18:21:30 +00:00
Fred Drake d3ba10f4b5 Clarify the prompt in an example.
This closes SF bug #450633.
2001-08-14 19:55:42 +00:00
Fred Drake 20c94913de Minor re-wording in the exaplantion of sequence comparisons.
This closes SF bug #445749.
2001-08-01 17:17:13 +00:00
Fred Drake 01815526e0 Add a more substantial example startup file for the interactive shell;
sample startup script provided by Itamar Shtull-Trauring.

This closes SF patch #410890.

Add some logical markup where it was missing.
2001-07-18 19:21:12 +00:00
Fred Drake 17f690f96b Minor changes to match the style guide. 2001-07-14 02:14:42 +00:00
Fred Drake ed51494666 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-06 17:28:39 +00:00
Fred Drake 88e66254f9 Use the more conventional "self" as the name of the self parameter in an
example.  It actually confused a reader.
2001-06-29 17:50:57 +00:00
Fred Drake d5df09cfb6 Update to include the license information in a less annoying place. 2001-06-20 21:37:34 +00:00
Tim Peters fa9e273442 Clarification in the fp appendix suggested on c.l.py by Michael Chermside.
Also replaced a *star* style emphasis in the Representation Error section
with an \emph{} thingie.
2001-06-17 21:57:17 +00:00
Fred Drake 7bc50714fe Fix the attributions for the new floating point text. 2001-06-08 17:09:01 +00:00
Fred Drake 8c27d99941 Added credits in the right places. 2001-06-08 16:28:53 +00:00
Fred Drake 417d667dd9 Text from Tim & Guido discussing floating point arithmetic and what users
need to understand about the binary & decimal fp, so that representation
weirdness is documented somewhere.  This makes it easier to repond to "bug"
reports caused by user confusion & ignorance of the issues.

This closes SF patch #426208.
2001-06-08 16:24:58 +00:00
Tim Peters bd695a716d Changed all the examples with ugly platform-dependent float output to use
numbers that display nicely after repr().  From much doctest experience
with the same trick, I believe people find examples with simple fractions
easier to understand too:  they can usually check the results in their
head, and so feel confident about what they're seeing.  Not even I get a
warm feeling from a result that looks like 70330.345024097141 ...
2001-05-22 06:54:14 +00:00
Fred Drake 8b0b8409ae Update output to reflect additional precision produced by the repr() of
floating point numbers in an interactive example.


Added comment to help explain control flow in the example code showing
how to check if a number is prime.

This closes SF bugs 419434 and 424552.
2001-05-21 16:55:39 +00:00
Fred Drake 9188b2194a Correct two floating-point representations printed by the interpreter in
interactive examples.  Error noted by Dinu Gherman.
2001-04-25 21:03:20 +00:00
Fred Drake 0c14961872 Update to reflect the new string repr -- \n instead of \012. This is the
only documentation file that appears to be affected by the change!
2001-04-12 04:26:24 +00:00
Fred Drake 5d6e402e0c Based on a comment by Konrad Hinsen on python-list:
Change "EOF" to "end-of-file", on the premise that it is easier for
new programmers to understand (at least a little).

This does not attempt to explain "file or device attached to standard
input."
2001-04-11 04:38:34 +00:00
Fred Drake 979d041b6f Make reference to the Library Reference in the "What Now?" chapter a
hyperlink.

Fix two English usage errors caught by Jan Wells:  Changed "subsequence"
to "sub-sequence" in two places, and avoid improper use of "hopefully" in
the first paragraph of the "What Now?" chapter.
2001-04-03 17:41:56 +00:00
Fred Drake 1b0b2a4df2 Add some LaTeX magic so that Latin-1 characters do not get so badly
trashed.
2001-03-13 17:56:08 +00:00
Fred Drake 67fdaa4883 Correct typos in Ping's email address.
Remove premature use of negative indexes in string operation examples;
negative indexes have not been explained at that point, and the use of
negative indexes are not necessary for the examples.
2001-03-06 07:19:34 +00:00
Fred Drake 162c6a637a Reflect change in traceback format:
"innermost last" --> "most recent call last"
2001-02-14 03:20:18 +00:00
Ka-Ping Yee 5401996638 Update to properly explain that the default Unicode encoding is ASCII, &c. 2001-02-13 22:20:22 +00:00
Ka-Ping Yee fa004ad36c Show '\011', '\012', and '\015' as '\t', '\n', '\r' in strings.
Switch from octal escapes to hex escapes for other nonprintable characters.
2001-01-24 17:19:08 +00:00
Fred Drake 0fe5af9b4d Clarify comments about returning None using a return without an expression;
this is not hard to explain!

Closes SF bug #129345.
2001-01-19 22:34:59 +00:00
Fred Drake cc97f8c609 Fix up an awkward sentence, pointed out by Chris Ryland <cpr@emsoftware.com>. 2001-01-01 20:33:06 +00:00
Fred Drake 4a6f1df48c Fix broken backslashes in Unicode strings section.
This closes bug #123730.
2000-11-29 06:03:45 +00:00
Tim Peters 657ebef2ae Partial fix for SF bug 123730: extra backslash in tutorial. 2000-11-29 05:51:59 +00:00
Tim Peters c113465a49 SF non-bug 123520: fleshed out the tutorial's lambda example a little more. 2000-11-27 06:38:04 +00:00
Fred Drake 0ac000cd54 Updates to reflect pending changes to the XML conversion process. 2000-11-22 16:42:37 +00:00
Fred Drake bce920129c Typo: shorted --> shorter
This closes bug #117706.
2000-10-25 23:22:54 +00:00
Fred Drake 860106ae90 Update the display of some floating point values at the interactive prompt
to reflect current behavior.
This closes SourceForge bug #117305.

Made a reference to the library reference a hyperlink.

Fixed some minor markup nits.
2000-10-20 03:03:18 +00:00
Fred Drake 31b761e326 Spelling: internalization --> internationalization
Fixed displays of the interactive prompt in running text.
These close SourceForge bug #115658.

Also:

Updated discussion of tuple unpacking to reflect the general ability
to unpack any sequence type.  Explained that it is possible to create
tuples which contain mutable values, and noted in the dictionary
section that such tuples cannot be used as keys.

Noted that .pyc and .pyo files can be run directly when provided as
the script parameter to the interpreter, and slightly clarified
comments about using modules with only the byte compiled code.

Removed some XXX comments that are no longer relevant.
Removed commented-out paragraph about __private names being experimental.

Adjusted markup for consistency in some places.
2000-09-29 15:17:36 +00:00
Fred Drake 343ad7a572 Correct some bitrot; some things have become inaccurate in the tutorial.
<file>.readlines() does not call <file>.readline() internally anymore,
and the sizehint parameter should be mentioned briefly.

Some displays of floating point numbers needed to be updated due to the
change in the repr() of floats (from 1.6).

Both issues were noted by Aahz <aahz@panix.com>.
2000-09-22 04:12:27 +00:00
Fred Drake 1349437e4c When referring to namespaces, always say "namespaces" instead of
"name spaces".

Inconsistency noted by Keith Briggs <keith.briggs@bt.com>.
2000-09-12 16:23:48 +00:00
Skip Montanaro 46dfa5f4ed require list comprehensions to start with a for clause 2000-08-22 02:43:07 +00:00
Fred Drake 1aebadf0e5 Ka-Ping Yee <ping@lfw.org>:
Further examples of list comprehensions.
2000-08-16 21:44:03 +00:00
Fred Drake 81f7eb6c6b Fix some markup errors that prevented formatting, and one that didn't. 2000-08-12 20:08:04 +00:00
Skip Montanaro 803d6e5451 list comprehensions. see
http://sourceforge.net/patch/?func=detailpatch&patch_id=100654&group_id=5470

for details.
2000-08-12 18:09:51 +00:00
Fred Drake 518e55c7f2 Rip out the information about the PSA, since the fate of that is not
certain.

Update the information about the mailing list, using the python.org
address instead of cwi.nl, and point to the pipermail archives.  Also
update the daily average message count (at the risk of scaring people
off), using the mail archive at http://www.egroups.com/group/python-list
for the first half of 2000 for statistical information.
2000-07-27 20:55:12 +00:00
Thomas Wouters f9b526dbfd More of Rob W. W. Hooft's spelling fixes. The only ones left now are the
distutils patches, which I'll leave to the distutils maintainers.

Tip: review the patch like this:

grep "^[\!+-] " <patchfile>

To get a quick and easy way to review the actual changes. Most of the
changes are single-line ones, anyway.
2000-07-16 19:05:38 +00:00
Fred Drake 5443c49fbb Markup improvements in sections relating to interactive behavior.
Clarify some of the details of readline-related configuration.
2000-07-08 05:18:54 +00:00
Fred Drake 30f76ffd00 Update version numbering from 1.6 to 2.0. 2000-06-30 16:06:19 +00:00
Fred Drake e99d1dbc74 Clarify the description of the else clause for try/except, and add an
explanation of why you'd want to use it.

Based on a question from Michael Simcich <msimcich@accesstools.com>.
2000-04-17 14:56:31 +00:00
Fred Drake 9dc30bb956 Marc-Andre Lemburg <mal@lemburg.com>:
Tutorial information about Unicode strings in Python, with some markup
adjustments from FLD.
2000-04-06 14:17:03 +00:00
Fred Drake 69fbf33680 Fixed typo in example code; spotted by Everett Lipman
<lipman@sphere.niddk.nih.gov>.
2000-04-04 19:53:06 +00:00
Fred Drake 20082d92f2 Merge in changes from the 1.5.2p2 release. 2000-04-03 04:26:58 +00:00
Fred Drake 37f1574f2e Use \citetitle and \programopt as appropriate. 1999-11-10 16:21:37 +00:00
Fred Drake 0ba58158c5 Added "import string" to a couple of examples that describe string
module functions, to clarify that the import is not automatic.
Suggested by Koray Oner <Koray.Oner@Eng.Sun.COM>.
1999-09-14 18:00:49 +00:00
Fred Drake 2900ff9382 Added paragraph explaining that except clauses can't be empty; that
pass can be used if needed.  By Dan Wolfe <wolfeman@apple.com>.
1999-08-24 22:14:57 +00:00
Fred Drake f1ad207f2a Made several grammatical corrections based on comments from Daniel
Barcla <danielb@digitalfocus.com>.

Also added example of what happens when a parameter is set both
positionally and by a keyword (one of Daniels suggestions related to
that paragraph).
1999-06-30 15:32:50 +00:00
Fred Drake f64f8a0877 Fixed typo reported by Bennett Benson
<BennettBenson@mn.mediaone.net>.
1999-06-10 15:30:21 +00:00
Fred Drake bdadf0f7f3 Explain comments at the start of chapter 3. This is needed since they
appear in the examples without any further explanation, and the
tutorial doesn't have this information explicit anywhere else.
Omission reported by Jon Black <jblack@Ridgeway-Sys.com>.
1999-04-29 13:20:25 +00:00
Fred Drake c0fcbc1ac6 Update starship URLs. 1999-04-29 02:30:04 +00:00
Fred Drake 511281ac00 In list of sequence comparison examples, "=" should be "==". Reported
by Mirko Liss <n89553@hrz.uni-paderborn.de>.
1999-04-16 13:17:04 +00:00
Fred Drake 93aa0f23a7 Fixed latex2html weirdness with footnotes. 1999-04-05 21:39:17 +00:00
Fred Drake 4b1a07ae18 Fixed grammatical error reported by Donald Wallace Rouse II
<dwr2@ix.netcom.com>.
1999-03-12 18:21:32 +00:00
Fred Drake ee84d5972f Lots of nits to respond to various comments from users. 1999-03-10 17:25:30 +00:00
Guido van Rossum 6b86a42c7f Document -OO; "unsafe" optimization that removes docstrings.
Marc-Andre Lemburg.
1999-01-28 15:07:47 +00:00
Guido van Rossum e51aa5b2cd Minor clarifications by Sean Reifschneider:
- add example of string literal concatenation
- add clarifying comment to the example of the if statement
1999-01-06 23:14:14 +00:00
Fred Drake cc09e8dc82 Clarified what Python versions the interactivity chapter applies to,
and what it doesn't apply to.
1998-12-28 21:21:36 +00:00
Fred Drake 2f8592cbea Ignore the byproducts of SGML/XML conversions for now. 1998-12-01 18:58:28 +00:00
Fred Drake f790b16d00 Change "for" explanation slightly based on comment passed along by
Blake Winton <BlakeW@pcdocs.com>.
1998-11-30 20:37:24 +00:00
Fred Drake db70d06464 Eliminate remaining \verb/.../ constructs; there's no need for them. 1998-11-17 21:59:04 +00:00
Guido van Rossum c62cf36e76 The last two example functions in the section about default argument
values (4.7.1) should return l, not a.  Reported by Axel Boldt.
1998-10-24 13:15:28 +00:00
Fred Drake b7833d3c0c Add a \label to the section "Fancier Output Formatting" (it's referenced from
the KOE docs).

Some markup nits.
1998-09-11 16:21:55 +00:00
Guido van Rossum aee5e26f4b Add warning that mutable argument defaults are evaluated only once;
with examples and workaround.  This keeps coming up, and I believe
that this section in the tutorial may have been (in part) the source
of the confusion.  While it didn't show examples with [] for a default,
it also didn't emphasize enough why that would be a bad idea, and
while it did say that defaults are evaluated at the point of function
definition, the example was not relevant for this issue.
1998-08-07 17:45:09 +00:00
Fred Drake 9f86b662d1 Update to use a separate page for front matter. 1998-07-28 21:55:19 +00:00
Guido van Rossum a4289a79f8 In the example iterating over sys.argv and opening each argument,
change it to iterate over sys.argv[1:].  Suggestion by Gerry Wiener.
1998-07-07 20:18:06 +00:00
Andrew M. Kuchling 108943c216 Added a section to the chapter on modules, describing the package system.
The text is almost completely from GvR's essay on packages; some
introductory paragraphs have been removed, and everything after the
'Details' section in the HTML has been dropped (seems too technical).  A
paragraph has been added after the sample package layout stating that there
must be a file called__init__.py in a directory to make it a package.
1998-07-01 13:58:55 +00:00
Guido van Rossum 002f7aae08 Note that no .pyc/.pyo files are created for script files. 1998-06-28 19:16:38 +00:00
Guido van Rossum a8a1b9bc65 There's no point in mentioning F6 as an alternate EOF on DOS -- it
doesn't work on modern Windows systems, and Control-Z works
everywhere.
1998-06-22 14:28:39 +00:00
Guido van Rossum 13c8ef62e6 Say a bit more about .pyc and .pyo files. 1998-05-29 19:12:23 +00:00
Fred Drake 7238988657 Fixed example to load the startup file from a script (didn't test for the
file's existance).

Removed some XXX comments about extension modules which support pickling.

Added text from AMK about the readline and rlcompleter modules.

Thanks, AMK!
1998-04-13 01:31:10 +00:00
Fred Drake c303e67f3c The built-in exceptions are not still strings, so make no claims about them. 1998-04-12 02:48:47 +00:00
Fred Drake e7957184d2 Change \sectcode to logical markup. 1998-04-04 07:17:47 +00:00
Fred Drake a594bafde7 Normalized case rules in section headings.
Moved stuff from "Recent Additions to 1.1" to "More on Defining Functions".
This means there's now a short section on "Defining Functions" immediately
followed by a long section "More on Defining Functions."
1998-04-03 05:16:31 +00:00
Fred Drake 391564f10f Small markup nits, a few grammatical fixes, and a clarification of the binary
mode for files under MacOS.

Updated the traffic figure for c.l.p in the "What Now?" chapter; see comments.
1998-04-01 23:11:56 +00:00
Fred Drake 6659c30b67 Convert LaTeX support to create a new class of documents. HTML generation
now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress).

This means that doing things to change the formatting of the manuals (at the
"normal user" level, like A4 paper), can happen in just one place, rather
than in each document file.
1998-03-03 22:02:19 +00:00
Fred Drake 6c2176eea7 Added \label{}s for logical addressing. 1998-02-26 21:47:54 +00:00
Fred Drake 8842e867af Remove \bcode / \ecode everywhere.
Make all the indentations in {verbatim} environments have column 0 of the
listing in column 0 of the file.

Remove pagenumbering / pagestyle cruft.

Use more logical and less physical markup.
1998-02-13 07:16:30 +00:00
Fred Drake ed68854b40 "lists objects" --> "list objects" (Section "More on Lists".) 1998-02-11 22:29:17 +00:00
Fred Drake 8d486b1779 In the appendix, all sections were marked as subsections, and so had section
numbers "A.0.#".  Fixed.
1998-02-11 22:12:18 +00:00
Fred Drake ca6567fb3f Use \url{} to mark URLs. 1998-01-22 20:44:18 +00:00
Fred Drake af8a015c93 Consistency: "{\bf ...}" ==> "\strong{...}"
"{\em ...}" ==> "\emph{...}"

	      Not at all sure what to do with "{\rm ...}".
	      Leaving it for now.
1998-01-14 14:51:31 +00:00
Fred Drake 4d4f9e726a Removed \mytableofcontents; just use \tableofcontents. 1998-01-13 22:25:02 +00:00
Fred Drake 3f20592c3e Consistency:
"Unix" ==> "\UNIX{}"

"C" ==> "\C{}"

"C++" ==> "\Cpp{}"
1998-01-13 18:56:38 +00:00
Fred Drake dca8792b52 Added openright option the the \documentclass{} for each of the manuals. 1998-01-13 16:53:23 +00:00