Commit Graph

391 Commits

Author SHA1 Message Date
Fred Drake 27cae1f7c5 Revise the __all__ index entry a touch. 2002-12-07 16:00:00 +00:00
Raymond Hettinger f9229d98ae Add __all__ to Reference Manual index.
Closes SF 643227.
2002-12-07 09:39:15 +00:00
Gustavo Niemeyer f955412130 * Doc/ref/ref5.tex
Fixed minor bug preventing documentation compilation.
2002-11-26 18:14:35 +00:00
Tim Peters 5b21df4a5c Repaired inaccuracies in the % docs. In particular, we don't (and can't)
guarantee abs(x%y) < abs(y) in all cases when a float is involved.
math.fmod() should, though, so noted that too.

Bugfix candidate.  Someone should check the LaTeX here first, though.
2002-11-24 20:23:04 +00:00
Fred Drake ce5619e8a1 Update: Older versions of Python crashed when calling repr()
(including the implied call using back-ticks) of a recursive object,
but this is no longer the case.
Reported by Manus Hand via email.
2002-11-13 15:32:34 +00:00
Raymond Hettinger 0da7f39a7c Closes SF bug #634069 reporting the docs on the ** operator were out
of date and did not reflect the current CPython implementation.
2002-11-08 05:30:23 +00:00
Fred Drake 79713fd9c6 Relocate an index entry so named anchors are not generated in a section head.
Closes SF bug #546579.
2002-10-24 19:57:37 +00:00
Fred Drake 78eb200758 Added cross-references to related material on exceptions.
Closes SF bug #217195.

Make sure section numbers wrap together with the preceeding word
("section").
2002-10-18 15:20:32 +00:00
Fred Drake e7097e0b1c Added cross-references to related material on exceptions.
Closes SF bug #217195.
2002-10-18 15:18:18 +00:00
Fred Drake 30be5768d2 Make sure section numbers wrap together with the preceeding word
("section").
2002-10-18 15:03:42 +00:00
Raymond Hettinger 463bfafd24 Clarify deprecation of the floor div operator, modulo operator,
and divmod() function for complex numbers.

Closes SF Bug 621708: Unclear deprecation.
2002-10-11 21:08:02 +00:00
Martin v. Löwis 36a4d8c20e Remove mentionings of DOS. 2002-10-10 18:24:54 +00:00
Fred Drake 74653820e3 Modified presentation of the grammar for calls to be easier to read
for both HTML and typeset renderings.  Corresponds to revision
1.53.4.8 on the r22-maint branch.
2002-10-07 16:28:38 +00:00
Fred Drake 5ec22f2d7b Another try at clarifying what goes into and comes out of Unicode objects.
Document the indices() method of slice objects.
2002-09-24 21:09:13 +00:00
Fred Drake 3e930ba55f Another try at clarifying what goes into and comes out of Unicode objects. 2002-09-24 21:08:37 +00:00
Raymond Hettinger a0e4d6ceaf Clarified that the footnote applies to versions 1.5 and after instead of
just version 1.5.  Closes SF bug 577793.
2002-09-08 21:10:54 +00:00
Martin v. Löwis f62a89b1e0 Ignore encoding declarations inside strings. Fixes #603509. 2002-09-03 11:52:44 +00:00
Skip Montanaro ee113f08f8 add warning about exception messages 2002-08-28 01:14:57 +00:00
Raymond Hettinger 83dcf5a290 Apply character{} markup. 2002-08-07 16:53:17 +00:00
Fred Drake f7aa164d7a Fix up some more markup problems. 2002-08-07 13:24:09 +00:00
Raymond Hettinger d9fdb51df6 Document handling of raw-unicode-escapes. Closes SF bug 587087. 2002-08-06 22:36:26 +00:00
Fred Drake 31f3db39f3 Fix the markup so it doesn't break formatting. 2002-08-06 21:36:06 +00:00
Martin v. Löwis 00f1e3f5a5 Patch #534304: Implement phase 1 of PEP 263. 2002-08-04 17:29:52 +00:00
Michael W. Hudson f0d777c56b A few days ago, Guido said (in the thread "[Python-Dev] Python
version of PySlice_GetIndicesEx"):

> OK.  Michael, if you want to check in indices(), go ahead.

Then I did what was needed, but didn't check it in.  Here it is.
2002-07-19 15:47:06 +00:00
Fred Drake 292724d989 Fix various typos reported to python-docs. 2002-06-26 21:52:26 +00:00
Raymond Hettinger 04e7e0c60f Close bug 417930 by clarifying augmented assignment docs 2002-06-25 13:36:41 +00:00
Raymond Hettinger 7fd9ced4ca Minor English grammar correction 2002-06-25 04:04:14 +00:00
Fred Drake 81932e234b Try to improve the explanation of the "raise" statement and how its arguments
are interpreted.
This closes SF bug #532467.
2002-06-20 20:55:29 +00:00
Fred Drake e08c9dbffc Simplify the production for argument list, making sure that it
actually allows all the legal syntax, and nothing else.  Previously,
it did not allow a call like func(arg, **dictionary).
This closes (again!) SF bug #493243.
2002-06-20 14:23:15 +00:00
Raymond Hettinger 10cbe8dcbc SF 563530 added missing methods for emulating numeric types 2002-06-20 06:12:37 +00:00
Fred Drake a23b5739bb Add a note about "as" not being a keyword, though it has special meaning
when used as part of the import statement.

Note that both "as" and "None" becoming keywords in the future.

Closes SF bug #553262.
2002-06-18 19:17:14 +00:00
Fred Drake 074712112b Played contortionist games with the argument_list production so it
might be easier to understand.
This relates to SF bug #493243, which will be closed.
2002-06-18 18:42:01 +00:00
Michael W. Hudson 495afea36e Typo. 2002-06-17 12:51:57 +00:00
Michael W. Hudson 5efaf7eac8 This is my nearly two year old patch
[ 400998 ] experimental support for extended slicing on lists

somewhat spruced up and better tested than it was when I wrote it.

Includes docs & tests.  The whatsnew section needs expanding, and arrays
should support extended slices -- later.
2002-06-11 10:55:12 +00:00
Fred Drake 293dd4b77b Fix up Guido's markup. 2002-06-04 16:25:57 +00:00
Guido van Rossum 92cf95f45b Addressed SF bug 421973 (finally).
Rewrote the subsection on coercion rules (and made it a proper
subsection, with a label).  The new section is much less precise,
because precise rules would be too hard to give (== I don't know what
they are any more :-).  OTOH, the new section gives much more
up-to-date information.

Also noted that __coerce__ may return NotImplemented, with the same
meaning as None.

I beg Fred forgiveness: my use of \code{} is probably naive.  Please
fix this and other markup nits.  An index entry would be nice.

This could be a 2.2 bugfix candidate, if we bother about old docs
(Fred?)
2002-06-03 19:06:41 +00:00
Raymond Hettinger 6cf09f0792 Patch 543387. Document deprecation of complex %, //,and divmod(). 2002-05-21 18:19:49 +00:00
Raymond Hettinger 94153096f5 Closes SF patch: 552468.
Type class unification invalidated the statement:  x.__getitem__[i] is not equivalent to x[i].
2002-05-12 03:09:25 +00:00
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