Commit Graph

353 Commits

Author SHA1 Message Date
Fred Drake af93c4c8d9 Added a missing "|" in the grammar productions used in the reference manual
(reported by François Pinard).
Added some missing "_" characters in the same cluster of productions.
Added missing floor division operator in m_expr production, and mention
floor division in the relevant portion of the text.
2002-04-30 02:18:51 +00:00
Fred Drake ed9e453eb7 Minor change to an index entry. 2002-04-23 20:04:46 +00:00
Fred Drake 70b3831697 Adjust markup to worm around tool limitations; the "m" in "model" was being
dropped in the HTML formatted version.
Reported by Mike Coleman.
2002-04-17 03:41:50 +00:00
Fred Drake c0a02c084b Remove repeated index entry; adds nothing different.
Closes SF bug #518985.
2002-04-16 02:03:05 +00:00
Martin v. Löwis 2a519f8fe6 Document __unicode__. Fixes #541245. 2002-04-11 12:39:35 +00:00
Fred Drake fd867719bc Fix typo: coverted --> converted. Reported by Francois Pinard. 2002-04-09 14:39:10 +00:00
Guido van Rossum 77f6a65eb0 Add the 'bool' type and its values 'False' and 'True', as described in
PEP 285.  Everything described in the PEP is here, and there is even
some documentation.  I had to fix 12 unit tests; all but one of these
were printing Boolean outcomes that changed from 0/1 to False/True.
(The exception is test_unicode.py, which did a type(x) == type(y)
style comparison.  I could've fixed that with a single line using
issubtype(x, type(y)), but instead chose to be explicit about those
places where a bool is expected.

Still to do: perhaps more documentation; change standard library
modules to return False/True from predicates.
2002-04-03 22:41:51 +00:00
Jeremy Hylton 88955cbe1f Change reference to execframes to naming. 2002-04-01 21:34:28 +00:00
Jeremy Hylton e604875b81 Restore a minimal definition of execution frame, since other parts of
the manual refer to it.

XXX Not sure that it belongs in this section, or that the concept is
particularly important for writing documentation.  Perhaps references
to the frame should be removed entirely.
2002-04-01 21:33:55 +00:00
Jeremy Hylton 1824b59e89 Update programmer's note on nested functions. 2002-04-01 21:30:15 +00:00
Jeremy Hylton f3255c8540 Reword explanation of global statement since an undeclared global is a
free variable and is subject to those rules.
2002-04-01 21:25:32 +00:00
Jeremy Hylton f0c1f1badb Note the sole case in which the ban on "from ... import *" within a
function is enforced.
2002-04-01 21:19:44 +00:00
Jeremy Hylton 15b68976da Remove the following restriction:
Names bound by import statements may not occur in global
    statements in the same scope.

Why not?
2002-04-01 21:18:02 +00:00
Jeremy Hylton d09ed68aeb Note that it is illegal to delete a cell variable.
Note that deleteing an unbound local will raise a NameError.
2002-04-01 21:15:14 +00:00
Jeremy Hylton 2225add242 Given lambda its own section, instead of burying it in boolean operators. 2002-04-01 21:05:21 +00:00
Jeremy Hylton 53ed917d3a Update / simplify Identifiers section for nested scopes.
How do I create a cross reference to section 4.1?
2002-04-01 20:52:24 +00:00
Jeremy Hylton e7d5773ed0 Update docs for nested scopes.
Replace section 4.1 with section A.3.

The new section 4.1 is titled "Naming and binding."  It includes the
text of section A.3 augmented with some of the detailed text from the
old section 4.1.

The \dfn, \index stuff is probably wrong, but I tried.

Also update other parts of appendix A to mention that nested scopes
and generators are standard features.
2002-04-01 20:38:01 +00:00
Jeremy Hylton 8392f36579 Update documentation of code objects.
Split the description of co_flags into two paragraphs.  The first
describes the flags that are used for non-future purposes, where
CO_GENERATOR was added.  The second describes __future__'s use of
co_flags and mentions the only one currently meaningful,
CO_FUTURE_DIVISION.
2002-04-01 18:53:36 +00:00
Jeremy Hylton 26c49b66bb Small fixes for description of function attributes.
func_closure is a readonly attribute.
Add \ttindex{} for func_closure.
Remove discussion of func_closure specific to 2.1.
2002-04-01 17:58:39 +00:00
Fred Drake f6eafc3fe1 Fix up unescaped tilde; reported by several people. 2002-03-18 16:47:14 +00:00
Fred Drake 83d14c12a6 Markup error: braces not properly marked in dictionary display
grammer productions.
Fixes SF bug #520959.
2002-03-16 06:35:54 +00:00
Fred Drake 5381588073 Revise the markup related to the grammar productions to increase the
level of predictability.  This is not really "good" markup, but is arguably
better than we had before.
This closes SF bug #523117.
2002-03-15 23:21:37 +00:00
Fred Drake 216cbca195 Typo: thsi -> this. Closes SF bug #521450. 2002-02-22 15:40:23 +00:00
Fred Drake aae728f292 Fix typo reported by François Pinard. 2002-01-21 16:09:18 +00:00
Fred Drake 687bde9433 Added some missing index entries, noted by L. Peter Deutsch.
This should be included in Python 2.2.1.
2001-12-27 18:38:10 +00:00
Fred Drake 08d752cf28 Update to use the notice environment so a multi-paragraph note can be
appropriately marked.
2001-12-14 22:55:14 +00:00
Fred Drake 591dd8f620 Update information about __del__() & reference cycles for CPython.
This partially fixes SF bug #492619.

Fix a typo & use the new notice environment instead of (ab)using the \note
and \warning macros.
2001-12-14 22:52:41 +00:00
Fred Drake b062cb22d0 Work around the problem of spaces after a "}" being dropped by LaTeX2HTML if
they were represented by newlines in the document source.
Partially fixes SF bug #493243.
2001-12-14 16:57:31 +00:00
Michael W. Hudson 850d3980ab Fix for
[ #429329 ] actual-parameters *arg, **kws not doc'd
2001-12-12 11:56:33 +00:00
Fred Drake 8d0645cb84 Add a note about yield requiring a __future__ directive. 2001-12-12 06:06:43 +00:00
Fred Drake 3a8e59ebe1 Clean up a sad sentence in the yield description. 2001-12-11 21:58:35 +00:00
Fred Drake e31e9cebc0 Document generators and the yield statement, avoiding implementation details. 2001-12-11 21:10:08 +00:00
Fred Drake 1d3e6c15ce Fix whitespace in example of bad indentation: a comment indicated that one
line was not indented at all, so the example is no longer indented at all.
All of the errors being shown remain.

Typo: characteru --> character
2001-12-11 17:46:38 +00:00
Fred Drake f9d580346b Add change notes where im_class is discussed, since the exact meaning changes
with Python 2.2.
2001-12-07 23:13:53 +00:00
Guido van Rossum b62f0e1a7b Correct the description of im_class. (Fred, this is changed in 2.2.
Should this be labeled as changed?  How?)
2001-12-07 22:03:18 +00:00
Fred Drake c2f496a138 Add a note to the description of the interaction between the softspace
attribute of file objects, the print statement, and other file operations.
This closes SF bug #484857.

Fix minor markup nits.
2001-12-05 05:46:25 +00:00
Guido van Rossum 4ed6be7107 Import the keyword module instead of relying on our own list of
reserved words.  No longer need to import string.
2001-12-04 20:39:36 +00:00
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