Commit Graph

5036 Commits

Author SHA1 Message Date
Fred Drake df872a2052 No need to be ambiguous about *how* extended slices and built-in types
have changed.

Uncomment a heading so that PendingDeprecationWarning doesn't seem so
out of place.
2002-07-03 12:02:01 +00:00
Fred Drake 228f6e4e7a Fix up a few more consistency nits and incorrectly applied markup.
Further clarify the English-centricity of fix_sentence_endings.
2002-07-03 05:08:48 +00:00
Fred Drake c412617779 Add annotations that describe the change in the "errors" and "failures"
attributes of the TestResult.
2002-07-02 22:46:42 +00:00
Fred Drake 387c8b5f37 Update the documentation of the errors and failures attributes of the
TestResult object.  Add an example of how to get even more information for
apps that can use it.
Closes SF bug #558278.
2002-07-02 22:34:44 +00:00
Greg Ward 285f4a7db7 Don't list all the keyword args to the TextWrapper constructor in the
classdesc -- just use "..." with prose explaining the correspondence
between keyword args and instance attributes.

Document 'width' along with the other instance attributes.

Describe default values consistently.

Typo fixes.
2002-07-02 21:48:12 +00:00
Fred Drake 2c22e85ae7 Attempt to clarify removedirs().
Based on SF bug #574773.
2002-07-02 21:03:49 +00:00
Fred Drake ca23ee273e Deal with & remove the XXX comments.
Change the markup to be more like the rest of the documentation.
2002-07-02 20:37:12 +00:00
Fred Drake ad74b7d4b3 Abstract the creation of signature lines for callable things; the new
\py@sigline macro will wrap the argument list so it will not extend into
the right margin.
Substantially based on a contribution from Dave Cole.
This addresses one of the comments in SF bug #574742.
2002-07-02 20:32:50 +00:00
Fred Drake abe7c1a4af Minor markup adjustments, consistency changes, and shorten a long
line.
2002-07-02 16:17:58 +00:00
Fred Drake 7c1bb9c528 Add refcount info for PyErr_SetFromWindowsErr() and
PyErr_SetFromWindowsErrWithFilename().
2002-07-02 16:16:18 +00:00
Thomas Heller 4f2722ac9b Docs for PyErr_SetFromWindowsErrWithFilename() and
PyErr_SetFromWindowsErr().
Fixes SF# 576016, with additional markup.
2002-07-02 15:47:03 +00:00
Martin v. Löwis 7d650ca83b Implement the encoding argument for toxml and toprettyxml.
Document toprettyxml.
2002-06-30 15:05:00 +00:00
Raymond Hettinger 550fd5d799 Fixed bug 574978 shutil example out of sync with source code 2002-06-30 04:43:20 +00:00
Raymond Hettinger 8a9e8b6d0e Fix bug 575221 referred to dictionary type instead of dict. 2002-06-30 04:32:38 +00:00
Fred Drake 78e057a32a Clarify the version information for the unicode() built-in.
Closes SF bug #575272.
2002-06-29 16:06:47 +00:00
Greg Ward ae64f3adcd Add documentation for new textwrap module. 2002-06-29 02:38:50 +00:00
Greg Ward 8b46c71d5b Typo fix. 2002-06-29 01:23:45 +00:00
Fred Drake d805fefff4 Added support for some of the more recently defined macros and
environments.
2002-06-27 18:38:06 +00:00
Fred Drake 2c813818c8 Clean up some markup. 2002-06-27 18:30:34 +00:00
Neal Norwitz dcd0500664 dis.dis() also supports modules 2002-06-26 22:32:47 +00:00
Fred Drake 292724d989 Fix various typos reported to python-docs. 2002-06-26 21:52:26 +00:00
Fred Drake 33fd5f7e02 Fix typo reported to python-docs. 2002-06-26 21:25:15 +00:00
Andrew M. Kuchling dcdf48a5c7 Add some acks 2002-06-26 13:28:19 +00:00
Andrew M. Kuchling d003a2a54f Describe textwrap module 2002-06-26 13:23:55 +00:00
Raymond Hettinger ca0383d3a3 Fix bug #573916. Sender and recipients reversed in email example. 2002-06-26 07:51:32 +00:00
Skip Montanaro 763805dab2 add seealso link to the bisect module 2002-06-26 05:22:08 +00:00
Skip Montanaro 09d9f86c77 add /F's PriorityQueue example 2002-06-26 05:07:28 +00:00
Andrew M. Kuchling fdc34315f7 Add a reminder 2002-06-26 00:03:05 +00:00
Andrew M. Kuchling 09d6b928e7 Add a reminder 2002-06-25 23:57:17 +00:00
Fred Drake c5e2792ab4 Talk about interfaces rather than implementation classes where appropriate.
Add hyperlinks to make the documentation on the Attributes and AttributesNS
interfaces more discoverable.
Closes SF bug #484603.
2002-06-25 17:10:50 +00:00
Fred Drake b6aa9cbb96 Added some more links to the "See also" section. 2002-06-25 16:58:58 +00:00
Fred Drake 7bc121a4fb When talking about interfaces, use the interface names, not the names
of the implementation classes.  (Remove the "Impl" from two names.)
2002-06-25 16:25:01 +00:00
Raymond Hettinger f0236d7374 Fix typo 2002-06-25 15:26:59 +00:00
Raymond Hettinger 07dc91800f Close bug 480337: Dict used before dicts explained. Added explanation
and examples of the dict() constructor.
2002-06-25 15:13:18 +00:00
Raymond Hettinger 04e7e0c60f Close bug 417930 by clarifying augmented assignment docs 2002-06-25 13:36:41 +00:00
Raymond Hettinger 5ed3fa6578 Fix SF bug 568269 by enclosing 'computername' in a raw string 2002-06-25 04:53:05 +00:00
Raymond Hettinger 7fd9ced4ca Minor English grammar correction 2002-06-25 04:04:14 +00:00
Raymond Hettinger 7951f60f45 Fix spacing in loop example 2002-06-25 03:17:03 +00:00
Neal Norwitz 563d12d145 SF # 572928 One word change for lib/libgettext.tex
Fix typo.
2002-06-24 02:22:39 +00:00
Fred Drake 723f94bd66 Convert the example C code to ANSI rather than K&R.
This matches the Python C style guide (PEP 7).
Closes SF patch #571489.
2002-06-22 01:42:00 +00:00
Fred Drake 53540ab071 Correct the RE equivalent of scanf()'s %x and %X patterns.
Closes SF bug #572169.
2002-06-22 01:07:37 +00:00
Greg Ward 6f45eeb0f3 Typo fix. 2002-06-21 12:33:08 +00:00
Fred Drake 1d1e1dba12 Corrected return type and value information for PyUnicode_Count() and
PyUnicode_Find().
This closes SF bug #566631.
2002-06-20 22:07:04 +00:00
Fred Drake 473f46a853 Make the docs for string.capitalize() match those of str.capitalize()
(which makes it more clear).
Closes SF bug #571767.
2002-06-20 21:18:46 +00:00
Fred Drake 807354f3b6 Add a note that divmod() with complex numbers is deprecated. 2002-06-20 21:10:25 +00:00
Fred Drake dce695aa4e Added reference to the Expat home page. 2002-06-20 21:06:03 +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 f4bf7aa292 Typo: bites --> bytes
(Hanging around small kids too much...;)
2002-06-18 20:38:05 +00:00
Fred Drake 9ea01d415f Add description of the deadlock problem with child processes and pipes, and
hints about how to work around it.
Closes SF bug #530637.
2002-06-18 20:30: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 69d1fd2fdb Note the limitation that mime_decode_header() only works for Latin-1.
Closes SF bug #551912.
2002-06-18 18:51:30 +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
Fred Drake 4837fa3a54 \productioncont: Replace leading spaces with   so that it's
possible to control the indentation of continuation lines.

cfuncline_helper():  Only mark the argument names are <var>, not the
    whole argument list.  This leaves the argument types in the same
    font as the return type.  Based on a casual suggestion from
    Guido.
2002-06-18 18:30:28 +00:00
Fred Drake f6e902717e Refactor the generation of signature lines for funcdesc, methoddesc,
and friends.  This was part of the changes to the presentation of
signature lines, but does not include any of the aspects that people
questioned.
2002-06-18 18:24:16 +00:00
Fred Drake 7f59124693 Clarified documentation for os.access().
Patch contributed by Sean Reifschneider.
Closes SF patch #570618.
2002-06-18 16:15:51 +00:00
Fred Drake 28bdc624a8 Clarified description of error handling for shutil.rmtree().
This closes SF patch #569832.
2002-06-18 14:31:04 +00:00
Fred Drake b084017c7a Fix documentation for PyMarshal_WriteObjectToFile() and
PyMarshal_WriteObjectToFile().
This closes SF bug #533735.
2002-06-17 15:44:18 +00:00
Fred Drake 6fc22f6c3d Ensure \verbatiminput always uses a unique filename for each input file in
the "Download as text" link.  Previously, it could map multiple source files
to a single name since all files end up with the same extension.
This closes SF bug #558279.
2002-06-17 15:01:05 +00:00
Andrew M. Kuchling 9f6e104c80 Add reminder, and a new POSIX function
Tweak traceback display for consistency
2002-06-17 13:40:04 +00:00
Michael W. Hudson 495afea36e Typo. 2002-06-17 12:51:57 +00:00
Piers Lauder 3fca291a52 Add IMAP4 QUOTA extension methods 2002-06-17 07:07:20 +00:00
Fred Drake a0c5e9fb74 Clean up descriptions of PyObject_RichCompare() and PyObject_RichCompareBool()
based on comments from David Abrahams.
Added refcount information for these functions.
2002-06-14 14:35:56 +00:00
Fred Drake a8ef0d1df2 Anchors ("a" elements) used only for the name attribute should not
change color on hover, only those that are link sources (href
attributes).
2002-06-14 13:47:58 +00:00
Steve Holden 1e4519faaa Make a start at describing the results of class/type unification
in the type documentation.
2002-06-14 09:16:40 +00:00
Fred Drake 6c123efe3d Refer the reader to the correct module for constant definitions.
This closes SF bug #550777.
2002-06-14 01:58:19 +00:00
Neal Norwitz 1f68fc7fa5 SF bug # 493951 string.{starts,ends}with vs slices
Handle negative indices similar to slices.
2002-06-14 00:50:42 +00:00
Fred Drake 585775bf11 Document the Binary.data attribute.
This closes SF bug #562878.
2002-06-14 00:33:02 +00:00
Neal Norwitz 9c92b69a54 Use \code{True} (or False) instead of true/false.
Not sure if code is correct, but that is what's in this file.
I've seen \constant{True} in other places.
2002-06-14 00:27:13 +00:00
Neal Norwitz cc5c6947a6 Add "version added" for getpgid 2002-06-13 21:19:25 +00:00
Martin v. Löwis 606edc1d97 Patch #568235: Add posix.setpgid. 2002-06-13 21:09:11 +00:00
Guido van Rossum fea59e7f76 The opcode FOR_LOOP no longer exists. 2002-06-13 17:59:51 +00:00
Fred Drake efb9097add Do not claim that getlocale() returns a tulpe; that is not always true.
Closes SF bug #568577.
2002-06-13 17:54:06 +00:00
Guido van Rossum 11ba094957 Major overhaul of timeout sockets:
- setblocking(0) and settimeout(0) are now equivalent, and ditto for
  setblocking(1) and settimeout(None).

- Don't raise an exception from internal_select(); let the final call
  report the error (this means you will get an EAGAIN error instead of
  an ETIMEDOUT error -- I don't care).

- Move the select to inside the Py_{BEGIN,END}_ALLOW_THREADS brackets,
  so other theads can run (this was a bug in the original code).

- Redid the retry logic in connect() and connect_ex() to avoid masking
  errors.  This probably doesn't work for Windows yet; I'll fix that
  next.  It may also fail on other platforms, depending on what
  retrying a connect does; I need help with this.

- Get rid of the retry logic in accept().  I don't think it was needed
  at all.  But I may be wrong.
2002-06-13 15:07:44 +00:00
Fred Drake 178153f8d6 Add documentation for PyObject_RichCompare() and PyObject_RichCompareBool(),
constributed by David Abrahams.
This closes SF patch #568081.
2002-06-13 11:51:48 +00:00
Fred Drake e9996c6093 Add version annotations for some older changes to the calendar module.
Closes SF patch #567867.
2002-06-13 01:34:50 +00:00
Guido van Rossum e3fdc975c0 SF bug 567826. Document new opcodes:
['BINARY_FLOOR_DIVIDE', 'BINARY_TRUE_DIVIDE',
'INPLACE_FLOOR_DIVIDE', 'INPLACE_TRUE_DIVIDE', 'GET_ITER',
'YIELD_VALUE', 'FOR_ITER', 'CONTINUE_LOOP']
2002-06-12 15:33:08 +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 55ad7f84a4 Completely revise markup for the list of list methods; the new markup matches
the semantics and presentation used in the library reference.
Added an explanation of the use of [...] to denote optional arguments, since
this is the only use of this in a signature line.
Closes SF bug #567127.
2002-06-11 02:56:17 +00:00
Guido van Rossum a861d552c3 Document that the key should not contain null bytes. 2002-06-10 19:42:43 +00:00
Guido van Rossum db9198a8b5 SF bug 563750 (Alex Martelli): posix_tmpfile():
The file returned by tmpfile() has mode w+b, so use that in the call
to PyFile_FromFile().

Bugfix candidate.
2002-06-10 19:23:22 +00:00
Andrew M. Kuchling 7f147a772d Tweak traceback message to avoid LaTeX2HTML bug
Add a reminder
2002-06-10 18:58:19 +00:00
Andrew M. Kuchling eb914881af Fix typo 2002-06-10 15:53:05 +00:00
Andrew M. Kuchling f70a0a8471 Fix typo, and add some reminders 2002-06-10 13:22:46 +00:00
Michael W. Hudson 497bdd69f2 Tweak the description of pymalloc. Mention pymemcompat.h. 2002-06-10 13:19:42 +00:00
Guido van Rossum 715b861d94 Clarify the interaction between timeout/non-blocking mode, makefile
and fromfd.
2002-06-07 12:38:23 +00:00
Neal Norwitz 62a7f63a24 Fix typo 2002-06-07 12:36:44 +00:00
Guido van Rossum fc9823b1a9 Clarify the interaction between blocking and timeouts. Explain that
fromfd() assumes a blocking non-timeout socket.
2002-06-07 03:39:21 +00:00
Neal Norwitz bdbd84fdac Add version info, and fix another typo and wording spotted by /F. I think this is what he meant. :-) 2002-06-06 22:24:10 +00:00
Fred Drake 1a06fb0605 Fix typo spotted by Fredrik Lundh. 2002-06-06 22:19:20 +00:00
Fred Drake 6c6d662760 Fix some markup errors and adjust wording slightly. 2002-06-06 21:57:48 +00:00
Guido van Rossum be946bfea7 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
I've made considerable changes to Michael's code, specifically to use
the select() system call directly and to store the timeout as a C
double instead of a Python object; internally, -1.0 (or anything
negative) represents the None from the API.

I'm not 100% sure that all corner cases are covered correctly, so
please keep an eye on this.  Next I'm going to try it Windows before
Tim complains.

No way is this a bugfix candidate. :-)
2002-06-06 21:51:01 +00:00
Martin v. Löwis 446a25fa3c Patch 473512: add GNU style scanning as gnu_getopt. 2002-06-06 10:58:36 +00:00
Fred Drake 293dd4b77b Fix up Guido's markup. 2002-06-04 16:25:57 +00:00
Walter Dörwald 474458da48 Add constants BOM_UTF8, BOM_UTF16, BOM_UTF16_LE, BOM_UTF16_BE,
BOM_UTF32, BOM_UTF32_LE and BOM_UTF32_BE that represent the Byte
Order Mark in UTF-8, UTF-16 and UTF-32 encodings for little and
big endian systems.

The old names BOM32_* and BOM64_* were off by a factor of 2.

This closes SF bug http://www.python.org/sf/555360
2002-06-04 15:16:29 +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
Guido van Rossum 59b2a74c75 SF bug 533625 (Armin Rigo). rexec: potential security hole
If a rexec instance allows writing in the current directory (a common
thing to do), there's a way to execute bogus bytecode.  Fix this by
not allowing imports from .pyc files (in a way that allows a site to
configure things so that .pyc files *are* allowed, if writing is not
allowed).

I'll apply this to 2.2 and 2.1 too.
2002-05-31 21:12:53 +00:00
Guido van Rossum 9788384d02 Explain that tp_basicsize must provide alignment for the items. 2002-05-31 21:00:18 +00:00
Fred Drake 9b414ac93e Update links and information on PyQt/PyKDE. 2002-05-31 18:21:56 +00:00