Commit Graph

316 Commits

Author SHA1 Message Date
Guido van Rossum 41c6719fe4 Put the keywords back in alphabetical order. Apparently somebody
didn't use reswords.py, as the comment clearly states. :-(
2001-12-04 20:38:44 +00:00
Fred Drake 3570551d6f Remove most references to __members__ and __methods__, leaving only one pair
of references that now state that these attributes have been removed,
directing the reader to the dir() function.
This closes SF bug #456420.
2001-12-03 17:32:27 +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
Jeremy Hylton 1336e99054 Fred observes that the typo was not the only problem with this sentence. 2001-11-14 21:38:13 +00:00
Jeremy Hylton 4a98f70a09 typo 2001-11-14 21:32:27 +00:00
Fred Drake 08fd51509c When describing "import *", add a level of indirection between "*" and the
set of names imported (the "public names"), adding a definition of "public
names" that describes the use of __all__.
This closes SF bug #473986.

Flesh out the vague reference to __import__().
2001-10-24 19:50:31 +00:00
Fred Drake 0aa811c527 Use the \note and \warning macros where appropriate. 2001-10-20 04:24:09 +00:00
Fred Drake 316141b333 Fix typo reported by Michael Soulier. 2001-10-18 15:22:23 +00:00
Tim Peters 1350c07de3 Removed stray backslash (a typo -- my fault). 2001-10-01 20:25:26 +00:00
Tim Peters 20524dbf36 The description of dictionary comparison was out of date. Rather than
try to explain the complex general scheme we actually use now, I decided
to spell out only what equality means (which is easy to explain and
intuitive), leaving the other outcomes unspecified beyond consistency.
2001-10-01 20:22:45 +00:00
Fred Drake 73921b0eec Refer to the objects which define __len__(), __*item__(), and __iter__()
as container objects rather than as mapping objects (in the index entries).
Change the section heading and intro sentence to be a little more general,
since that's how things have actually evolved.
2001-10-01 16:32:13 +00:00
Fred Drake 18d8d5a708 Fix minor usage and consistency nits. 2001-09-18 17:58:20 +00:00
Fred Drake ed5a7ca5ee Work around a LaTeX2HTML bug that caused the "m" in "mutable" to be dropped
in one place.
2001-09-10 15:16:08 +00:00
Tim Peters d507dab91f SF patch #455966: Allow leading 0 in float/imag literals.
Consequences for Jython still unknown (but raised on Jython-Dev).
2001-08-30 20:51:59 +00:00
Michael W. Hudson 53da317801 Docs for the PEP 264 changes. 2001-08-27 20:02:17 +00:00
Fred Drake c0cf726d8c Add material about the "r" and "u" prefixes for string literals; should
be reviewed for clarity.

Work around a bogosity in the HTML version of the escape sequences table
conversion.
2001-08-14 21:43:31 +00:00
Fred Drake 3e2aca48bd Add information about __floordiv__() and __truediv__() methods for
implementing numeric objects in Python.
2001-08-14 20:28:08 +00:00
Fred Drake a7d608d1cf "Thin" version of floor division docs: add // to the list of operators
and //= to the list of other delimiter tokens.

I'll work on it again when it's not so late...
2001-08-08 05:37:21 +00:00
Fred Drake 8dd6ffd0ec User-defined methods *can* contain things other than user-defined functions
as the callable, so use more flexible language.
2001-08-02 21:34:53 +00:00
Fred Drake 044bb4d22a Explain that __init__() methods do not get to return values. 2001-08-02 15:53:05 +00:00
Fred Drake 9079164bdf Removed unnecessary section "Unicode literals"; all the discussion is
already present in the "String literals" section, including comments on
the "u" prefix and the additional escape sequences used for Unicode.

This relates to SF bug #442526.
2001-07-20 15:33:23 +00:00
Fred Drake 0825dc2427 Fix typo in description of raw strings: "value" --> "valid"
This closes SF bug #443059.
2001-07-20 14:32:28 +00:00
Fred Drake 6e5e1d924c Minor change to match the style guide. 2001-07-14 02:12:27 +00:00
Fred Drake cb4638a278 Change the grammar productions to use the new productionlist environment;
this supports a hyperlinked version of the grammar that can make tracking
down details and definitions a little easier.
2001-07-06 22:49:53 +00:00
Andrew M. Kuchling e7e03cd0cf Fix typo 2001-06-23 16:26:44 +00:00
Fred Drake be9d10edbb Remove some bogus trailing whitespace. 2001-06-23 06:16:52 +00:00
Fred Drake 93852ef3c8 Fix minor markup nits. 2001-06-23 06:06:52 +00:00
Fred Drake deda9f3420 Use a named reference to another chapter instead of hard coding the
chapter number.  This also makes the reference a hyperlink in the HTML
version.
2001-06-23 06:06:21 +00:00
Fred Drake 2829f1cf99 Fix a very minor (but annoying when looking for things!) markup nit. 2001-06-23 05:27:20 +00:00
Fred Drake f5eae668a8 Add "yeild" to the list of keywords.
Fix a very minor (but annoying when looking for things!) markup nit.
2001-06-23 05:26:52 +00:00
Fred Drake d5df09cfb6 Update to include the license information in a less annoying place. 2001-06-20 21:37:34 +00:00
Fred Drake 88382696f4 Update a "Programmer's note" about lambda forms and scoping to reflect
the availability of nested scoping in Python 2.1 and 2.2.
2001-06-05 02:17:02 +00:00
Fred Drake 597bc1d46f Bring the notes on the relationship between __cmp__(), __eq__(), and
__hash__() up to date (re: use of objects which define these methods
as dictionary keys).

This closes SF bug #427698.
2001-05-29 16:02:35 +00:00
Fred Drake b9879e1020 Fix typo reported in SF bug #427783. 2001-05-29 15:44:27 +00:00
Fred Drake b3384d3555 Make sure we include all of Python's numeric types in the data model
description, so that the introduction of complex is not a surprise.

This closes SF bug #423429.
2001-05-14 16:04:22 +00:00
Fred Drake 7c116d7acb Fix typo reported by David Goodger. This closes SF patch #422383. 2001-05-10 15:09:36 +00:00
Fred Drake b8ac0096b2 Fix the operator precedence table: exponentiation binds tighter than
negation.

This closes SF bug #421999.
2001-05-09 16:51:49 +00:00
Guido van Rossum 0dbb4fba4c Implement, test and document "key in dict" and "key not in dict".
I know some people don't like this -- if it's really controversial,
I'll take it out again.  (If it's only Alex Martelli who doesn't like
it, that doesn't count as "real controversial" though. :-)

That's why this is a separate checkin from the iterators stuff I'm
about to check in next.
2001-04-20 16:50:40 +00:00
Fred Drake 62effc1127 Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping. 2001-04-13 15:55:25 +00:00
Fred Drake fb8ffe6b5e Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.
Wrap some long lines and fix some markup nits.
2001-04-13 15:54:41 +00:00
Fred Drake 24e7a29292 Work around the conversion of ">>" and "<<" to guillemets. Reported by
Ping on the Doc-SIG mailing list.
2001-04-12 12:37:03 +00:00
Fred Drake e2645775d1 Typo: "ariables" --> "variables"
This fixes SF bug #411118.
2001-03-28 16:55:53 +00:00
Jeremy Hylton aa90adcfb9 Add nested scopes spec to appendix.
Add new opcodes LOAD_CLOSURE, LOAD_DEREF, STORE_DEREF, MAKE_CLOSURE to
docs for dis module.

Add docs for new function and code members in Sec. 3 of ref manual.
They're present regardless of whether nested scopes are used.

Remove description of default argument hack from Sec. 7 of the ref
manual and refer the reader to the appendix.
2001-03-23 17:23:50 +00:00
Fred Drake a9d0450f72 No quotes around the "future" in the first use of the term "future
statement".
2001-03-23 16:47:11 +00:00
Fred Drake 557c1ae150 Include the futures appendix. 2001-03-23 16:21:15 +00:00
Fred Drake 39778b705d Revise the markup so that this formats and uses markup consistently with
the rest of the documentation.
2001-03-23 16:20:46 +00:00
Jeremy Hylton 324cc6ee0e Add some initial text for the appendix on future statements and nested scopes. 2001-03-23 15:29:54 +00:00
Jeremy Hylton 2c84fc8a7d Note that assignments to __debug__ are illegal 2001-03-23 14:34:06 +00:00
Jeremy Hylton e702481d38 Revert to ver 1.22, which was the version before the nested scopes
docs were introduced.  This loses a few small changes, but Fred says
that's okay.
2001-03-23 14:05:16 +00:00
Fred Drake 859eb62108 Do not refer to "sub-modules" since that is not a defined term. 2001-03-06 07:34:00 +00:00
Fred Drake ac79e95167 Re-word the explanation of the in/not in operators for increased content
and clarity.

Add a footnote to the information on the possibility of shadowing builtins
with locals & module globals.
2001-03-06 07:32:11 +00:00
Barry Warsaw 7a5e80e801 Updates to describe function attributes. 2001-02-27 03:36:30 +00:00
Fred Drake 230d17d0d1 Sequence indexes are non-negative, not natural (0 is not a natural number).
Reported by Daniel May <mayds@ecn.purdue.edu>.

De-tabified everywhere.
2001-02-22 21:28:04 +00:00
Tim Peters 7530208d8b Feeble attempt to repair obsolete info about hex escapes. 2001-02-14 04:03:51 +00:00
Fred Drake 667c9e46ca Minor markup adjustments.
Move some index entries next to what they are referring to for better
"targetting".
2001-02-02 02:43:18 +00:00
Jeremy Hylton 3faa52ecc4 Allow 'continue' inside 'try' clause
SF patch 102989 by Thomas Wouters
2001-02-01 22:48:12 +00:00
Fred Drake c2e35e6f37 Remove spurious "\end{description}" that caused formatting to fail. 2001-02-01 15:37:56 +00:00
Jeremy Hylton 0eb107068a update section 4.1 to describe nested scopes 2001-02-01 03:50:59 +00:00
Jeremy Hylton 10f8ba4fc6 Remove note about the compiler not checking for two kinds of illegal
imports.  It checks for them now.
2001-01-30 01:25:15 +00:00
Fred Drake 2f4453af6a Typo: coplete --> complete
This closes SF bug #129759.
2001-01-26 15:27:35 +00:00
Fred Drake c8e8281fb6 Updated note about collection of cyclic garbage, based on comments from
Chris Ryland.
2001-01-22 17:46:18 +00:00
Guido van Rossum ab782dd6cc Document rich comparisons. 2001-01-18 15:17:06 +00:00
Fred Drake 34bafcc079 Fix a variety of minor nits and typos caught by Chris Ryland
<cpr@emsoftware.com>.
2001-01-14 02:57:14 +00:00
Fred Drake 347a62505c Steve Holden <sholden@holdenweb.com>:
Clarify the handling of characters following backslashes in raw strings.
2001-01-09 21:38:16 +00:00
Fred Drake 445f832060 __rcmp__() description: Changed to indicate that this is no longer
supported as of Python 2.1.  We still need to
                         have an entry for this since it is reasonable
                         for users to want to understand existing code.

This closes SF bug #122715.
2001-01-04 15:11:48 +00:00
Neil Schemenauer 48c2eb9165 Document the NotImplemented object. 2001-01-04 01:25:50 +00:00
Fred Drake 2cba0f641f Improve description of else clause of the try/except/else statement.
This closes (again!) bug #127098.
2001-01-02 19:22:48 +00:00
Thomas Wouters 8e2b6b5cc7 Change documentation of 'else' clause of 'try/except' to make clear that it
doesn't get triggered by 'return', 'break' or 'continue'. If the
'try-inside-continue' patch does not get accepted before next release, the
'or continue' should be removed ;P

Closes SF patch #103045 and SF bug #127098.
2000-12-31 22:52:59 +00:00
Andrew M. Kuchling 68abe832b9 Fix typo 2000-12-19 14:09:21 +00:00
Fred Drake dea764d7f1 Updated string literals description to encompass Unicode literals and the
additional escape sequences defined for Unicode.
This closes bug #117158.
2000-12-19 04:52:03 +00:00
Guido van Rossum 035f7e88c8 Clarify __repr__ and __str__. 2000-12-19 04:18:13 +00:00
Thomas Wouters dc90cc2b15 Additional docs for __iadd__ and family, closing SF bug #117178 and SF patch
#102169.
2000-12-11 23:11:51 +00:00
Fred Drake 2a22200ab4 Adjust explanation of operator precedence summary -- exponentiation groups
from right to left!

Closes bug #125391.
2000-12-11 22:39:24 +00:00
Fred Drake c3b18d7ca8 Fix error noted by Gerrit Holl (old; had been buried in my INBOX):
sequence repitition works just fine with long integers now, so we
should not say that only plain integers are allowed.
2000-12-07 04:54:02 +00:00
Fred Drake 0c47559352 Added a note that objects which emulate built-in types should only
implement as many of the relevant methods as make sense for the particular
information being modelled.
2000-12-07 04:49:34 +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 2ed27d3189 Note that readframes() returns data in linear format, even if the original
is encoded in u-LAW format.  Based on suggestion from Anthony Baxter
<anthony_baxter@users.sourceforge.net>.

This closes bug #122273.
2000-11-17 19:05:12 +00:00
Fred Drake f89259786a Denis S. Otkidach <ods@users.sourceforge.net>:
Show how code can be written to handle __getslice__ & friends in a way that
is compatible with pre-2.0 versions of Python while still working with the
"new" way of handling slicing.

Additional explanation added by Fred Drake.

This closes SourceForge patch #101388.
2000-09-21 22:27:16 +00:00
Fred Drake d68442b164 Lots of minor fixes, many suggested by Detlef Lannert
<lannert@uni-duesseldorf.de>.
2000-09-21 22:01:36 +00:00
Fred Drake 31575ce817 Note that __getitem__() may receive a slice object as the index;
reported by Detlef Lannert <lannert@uni-duesseldorf.de>.
2000-09-21 05:28:26 +00:00
Fred Drake 8d27f898b2 Moshe Zadka <mzadka@geocities.com>:
Document the __contains__() method.
(Patch slightly modified by FLD.)

This closes SourceForge patch #101387.
2000-09-19 18:21:25 +00:00
Fred Drake 1156f62348 Many small clarifications, including many suggested by email. 2000-09-19 18:10:05 +00:00
Fred Drake 31f5550fbe Thomas Wouters <thomas@xs4all.net>:
Reference manual docs for augmented assignment.

This closes SourceForge patch #101418.
2000-09-12 20:32:18 +00:00
Skip Montanaro b655939d69 add index entries for list comprehensions 2000-09-11 16:31:55 +00:00
Barry Warsaw 33f785fc1e Document "print >> None" 2000-08-29 04:57:34 +00:00
Thomas Wouters 12bba852a9 Rough and incomplete documentation on augmented assignment, which follows
shortly. Markup also needs checking.
2000-08-24 20:06:04 +00:00
Skip Montanaro 323fe5df6a fix list comprehension discussion to use \keyword macro instead of simply
quoting keywords.
2000-08-23 17:03:34 +00:00
Skip Montanaro 46dfa5f4ed require list comprehensions to start with a for clause 2000-08-22 02:43:07 +00:00
Barry Warsaw 8c0a242289 PEP 214, Extended print Statement, has been accepted by the BDFL.
Document the extended print form.  Fred, please double check the
markup!
2000-08-21 15:45:16 +00:00
Thomas Wouters 8bad612881 Disallow "import mod.submod as m", because the result is ambiguous. Does it
load mod.submod as m, or mod as m ? Both can be achieved differently, and
unambiguously. Also attempt to document this restriction (editor
appreciated!)

Note that this is an artificial check during compile, because incorporating
this in the grammar is hard, and then adjusting the compiler to do the right
thing with the right nodes is harder.
2000-08-19 20:55:02 +00:00
Fred Drake a00738259f Adjust the way __getslice__() is marked as deprecated; this will also
stand out more.
2000-08-18 02:42:14 +00:00
Thomas Wouters 5215225ea1 Apply SF patch #101135, adding 'import module as m' and 'from module import
name as n'. By doing some twists and turns, "as" is not a reserved word.

There is a slight change in semantics for 'from module import name' (it will
now honour the 'global' keyword) but only in cases that are explicitly
undocumented.
2000-08-17 22:55:00 +00:00
Thomas Wouters 1d75a79c00 Apply SF patch #101029: call __getitem__ with a proper slice object if there
is no __getslice__ available. Also does the same for C extension types.
Includes rudimentary documentation (it could use a cross reference to the
section on slice objects, I couldn't figure out how to do that) and a test
suite for all Python __hooks__ I could think of, including the new
behaviour.
2000-08-17 22:37:32 +00:00
Fred Drake d341579178 Fix error made in applying Thomas's patch. 2000-08-15 18:44:10 +00:00
Fred Drake a1e214a1ed Thomas Wouters <thomas@xs4all.net>:
Update the grammar to reflect the most recent changes to list
comprehensions.
2000-08-15 17:54:49 +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 3d83fc3ab1 Change as suggested by Peter Funk <pf@artcom-gmbh.de>:
Create a hyperlink between the language reference and documentation for
the built in functions.
2000-07-31 20:08:23 +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 91826ed2a9 Improve the descriptions of expected exceptions for __getitem__(),
__setitem__(), and __delitem__().  Based on related comments from
Barry Warsaw.
2000-07-13 04:57:58 +00:00
Fred Drake 7399b9e6e4 Moshe Zadka <mzadka@geocities.com>:
Update the "in" / "not in" description to accomodate the current use
of the __contains__() discipline.  This patch also incorporates
suggestions from Marc-Andre Lemburg <mal@lemburg.com>, minor markup
revisions from Fred Drake, and some rewording of the first affected
paragraph (also from Fred).

Closes SourceForge patch #100831.
2000-07-11 19:43:47 +00:00