Commit Graph

5118 Commits

Author SHA1 Message Date
Andrew M. Kuchling 90e9a79afd Add 'in' change
Revise sentence
Add two reminders
2002-08-15 00:40:21 +00:00
Fred Drake 794643c314 Py_InitModule() and friends now accept NULL for the 'methods'
argument.  This makes sense now that extension types can support
__init__ directly rather than requiring function constructors.
2002-08-14 20:59:38 +00:00
Barry Warsaw b8c20a723f More updates describing FutureWarnings. 2002-08-14 16:40:54 +00:00
Tim Peters 2f238c1b22 mkstemp's last argument changed from binary=True to text=False. 2002-08-14 16:37:10 +00:00
Barry Warsaw 29ce2d7d1e Document PyExc_FutureWarning 2002-08-14 16:06:28 +00:00
Fred Drake 5c08a99b77 Remove a broken example of extreme backward compatibility; it is
simply not relevant any more.
Closes SF bug #595032.
2002-08-14 15:26:18 +00:00
Fred Drake 918af2aef7 The auto-reply text for the python-docs address. This is not automatically
updated when checkins are made, but I can get that updated when needed.
2002-08-12 22:01:42 +00:00
Fred Drake a132f6c38b Accomodate the packaging changes when we unpack into the dev/doc/ area
on python.org.
2002-08-09 22:56:46 +00:00
Fred Drake 1a0199a74f Lots of changes to the packaging of the documentation, all to keep
directories clean where the packages are unpacked.  Each package now
contains a single directory, Python-Docs-<version>/, which contains the
files for that version of the documentation.

Closes SF feature request #567576.
2002-08-09 20:20:50 +00:00
Guido van Rossum 830a5151c1 Doc portion of SF 589982 (tempfile.py rewrite, by Zack Weinberg).
Fred, please review!
2002-08-09 16:16:30 +00:00
Raymond Hettinger ae7ef57cba GvR pointed out that only enclosing function bodies are part of nested scopes. 2002-08-07 20:20:52 +00:00
Guido van Rossum b2865919cc Document that heappop() and heapreplace() raise IndexError if the heap
is empty.
2002-08-07 18:56:08 +00:00
Raymond Hettinger 83dcf5a290 Apply character{} markup. 2002-08-07 16:53:17 +00:00
Raymond Hettinger 22c001bd29 Described responsibilty of weakly referenced extension types to initialize
the weakreflist to NULL in the constructor and to fill the tp_flags
slot with Py_TPFLAGS_HAVE_WEAKREFS.  Closes SF bug 586583.
2002-08-07 16:18:54 +00:00
Raymond Hettinger 861bb02448 Describe nested scopes in the tutorial. Closes SF bug 500704. 2002-08-07 16:09:48 +00:00
Raymond Hettinger 3cfdc3402e Documented os.fsync and os.fdatasync. Closes SF bug 584695. 2002-08-07 15:48:17 +00:00
Fred Drake 442c7c7743 Clarify that the bool instances are acceptable return values from
__nonzero__(), in response to SF bug #579991.
2002-08-07 15:40:15 +00:00
Fred Drake f7aa164d7a Fix up some more markup problems. 2002-08-07 13:24:09 +00:00
Fred Drake 95fa4ddf7b Change the markup a bit more; the parameter was not marked as \var in the
sample code, and the note was marked as a logical thing.
2002-08-07 12:39:33 +00:00
Steve Holden 63d5bead18 Fix markup errors. 2002-08-07 12:01:41 +00:00
Raymond Hettinger d9fdb51df6 Document handling of raw-unicode-escapes. Closes SF bug 587087. 2002-08-06 22:36:26 +00:00
Jack Jansen d37f75b88a Added a note about the inability to specify a pathname to a non-existing
file in unix-Python.
2002-08-06 22:15:23 +00:00
Jack Jansen 4104b50b52 Changed a sentence that confused some people. 2002-08-06 22:14:23 +00:00
Fred Drake 31f3db39f3 Fix the markup so it doesn't break formatting. 2002-08-06 21:36:06 +00:00
Fred Drake 2d3c03df9a Added references to the email package.
Closes SF bug #586937.
2002-08-06 21:26:01 +00:00
Guido van Rossum 43af5b5852 Add some fine points: METH_KEYWORDS implies METH_VARARGS, and ob_size
is no longer unused in type objects.
2002-08-06 17:18:56 +00:00
Guido van Rossum 97c5fccd77 Remove mention of deprecated xreadlines method. 2002-08-06 17:03:25 +00:00
Guido van Rossum 0fc01865f3 Document file.next(). Mark xreadlines obsolete (both method and
module).  (One thing remains to be done: the gzip class has an
xreadline method; this ought to be replaced by an iterator as well.)
2002-08-06 17:01:28 +00:00
Barry Warsaw 817918cc3c Committing patch #591250 which provides "str1 in str2" when str1 is a
string of longer than 1 character.
2002-08-06 16:58:21 +00:00
Steve Holden 545092b063 Add comment about os.path.walk()'s behavior with symbolic links. 2002-08-06 16:07:07 +00:00
Andrew M. Kuchling 950725f755 Mention list.sort()
Document heapq module
Add PEP263 section (not sure I really understand the PEP's effect on 8-bit
   strings, though -- will have to experiment with it)
2002-08-06 01:40:48 +00:00
Neal Norwitz e72a9a13a1 SF patch #591305 Documentation err in bytecode defs 2002-08-05 23:33:54 +00:00
Raymond Hettinger acb45d72b4 Note that True and False are pickable objects 2002-08-05 03:55:36 +00:00
Martin v. Löwis 00f1e3f5a5 Patch #534304: Implement phase 1 of PEP 263. 2002-08-04 17:29:52 +00:00
Steve Holden c8389c91c2 Remove a syntax error in the example, spotted by Walter Hofman. 2002-08-04 15:27:25 +00:00
Andrew M. Kuchling c61ec523ed Add two reminders 2002-08-04 01:20:05 +00:00
Tim Peters 0ad679ff0f Document new heapreplace() function. 2002-08-03 18:53:28 +00:00
Tim Peters 6e0da82a97 Document new heapify() function. 2002-08-03 18:02:09 +00:00
Fred Drake 1acab695a7 Minor markup changes. 2002-08-02 19:46:42 +00:00
Fred Drake b481286504 Add a comment showing how one of the macros should be used. 2002-08-02 18:30:22 +00:00
Fred Drake ad09bbfce3 Add heapq module docs to the dependency information. 2002-08-02 18:20:34 +00:00
Guido van Rossum 975121664e Add docs for heapq.py. 2002-08-02 18:03:24 +00:00
Skip Montanaro de994d9130 indicate that 'b' is added to the mode flag if not given 2002-08-02 17:20:46 +00:00
Tim Peters 74824584ef Added new footnote about list.sort() stability. Repaired footnote about
using sort() with comparison functions (it made reference to the non-
existent "builtin-in function sort()").

BTW, I changed list.sort's docstring to contain the word "stable" -- the
easiest way to tell whether a particular Python version's sort *is* stable
is to look for "stable" in the docstring.  I'm not sure whether to
advertise this <wink>.
2002-08-01 03:10:45 +00:00
Mark Hammond 543fb35cca Replace DL_EXPORT with PyMODINIT_FUNC 2002-07-31 06:17:46 +00:00
Fred Drake 5b11bdd0ed SF patch #581414: info reader bug
The "Matching vs. Searching" Info node is unreachable from the Info
program (but is fine in Emacs's Info mode). This patch seems to fix
it.  This is the only occurrence where the info reader fails, so
probably it could be addressed in the python docs as a workaround.
Forwarded the report to the info maintainer.
2002-07-30 17:51:20 +00:00
Thomas Heller 085358a3e2 New functions for extension writers on Windows:
PyErr_SetExcFromWindowsErr(), PyErr_SetExcFromWindowsErrWithFilename().

Similar to PyErr_SetFromWindowsErrWithFilename() and
PyErr_SetFromWindowsErr(), but they allow to specify
the exception type to raise. Available on Windows.

See SF patch #576458.
2002-07-29 14:27:41 +00:00
Andrew M. Kuchling 52f1b76f6c Add posix.lchown() 2002-07-28 20:29:03 +00:00
Martin v. Löwis 0cec0ffc78 Patch #573770: Implement lchown. 2002-07-28 16:33:45 +00:00
Neal Norwitz 4ddfd50d85 Fix SF bug 587012, doc mentions inexistent builtin unistr 2002-07-28 13:55:20 +00:00
Fred Drake db40afaabe Small clarifications when referring to the sys.exc_* variables so that
readers are not given the wrong impression that they should be using those
on a regualar basis.
This closes SF bug #585598.
2002-07-25 21:11:23 +00:00
Jeremy Hylton 403e351dfc Flesh out description of getlogin() and recommend against using it. 2002-07-24 15:32:25 +00:00
Andrew M. Kuchling ef5d06bd3f [Bug #580462] Mention changes to GC API
Mention portable strptime()
Move C-level sections farther down in the file
2002-07-22 19:21:06 +00:00
Andrew M. Kuchling a982eb1eb5 Sort changed modules into alphabetical order; no other changes 2002-07-22 18:57:36 +00:00
Andrew M. Kuchling 3c305d966d Rewrite a paragraph, and use correct mark-up 2002-07-22 18:50:11 +00:00
Neal Norwitz bba23a897e SF bug #583894, add doc for DL_IMPORT/DL_EXPORT deprecation 2002-07-22 13:18:59 +00:00
Neal Norwitz 1cfcafceb6 add versionadded to doc 2002-07-20 00:46:12 +00:00
Guido van Rossum 18eb8b85b3 Doc patch from SF 474274 (pure Python strptime by Brett Cannon). 2002-07-19 17:09:36 +00:00
Michael W. Hudson 4da01ed9a8 Substantially flesh out extended slice section. I think this is probably
done now.
2002-07-19 15:48:56 +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
Mark Hammond 8235ea1c3a Land Patch [ 566100 ] Rationalize DL_IMPORT and DL_EXPORT. 2002-07-19 06:55:41 +00:00
Fred Drake f0b095d804 Added documentation for the buffer_text and related attributes of the
xmlparser object provided by pyexpat, new in Python 2.3.
2002-07-17 20:31:52 +00:00
Fred Drake 50ceb68b4f Change staticforward and statichere to just use static.
Removed ^M from some line-ends.
2002-07-17 16:42:48 +00:00
Fred Drake a3cd9bbaa3 Remove now-obsolete staticforward/statichere discussion. 2002-07-17 16:40:39 +00:00
Fred Drake 2095b9690f reduce(): Clarified what is returned in the case of a sequence 1 item long and
initial/default value.
2002-07-17 13:55:33 +00:00
Guido van Rossum 9534e14033 Record the decision that StopIteration is a sink state (see recent
discussion in python-dev with subject "Termination of two-arg iter()").

Implementation will follow.
2002-07-16 19:53:39 +00:00
Guido van Rossum 54ed2d32f9 Clarify that the description of sys.path[0] is only valid upon program
start-up.
2002-07-15 16:08:10 +00:00
Andrew M. Kuchling 346386fedc Add more items
Use \cfunction instead of \function in various places
Add contributor names
2002-07-12 20:24:42 +00:00
Fred Drake 3e59f72075 Clarify the return value of __nonzero__(): It *must* be an integer.
Closes SF bug #579991.
2002-07-12 17:15:10 +00:00
Andrew M. Kuchling 20e5abc86e Make another pass through Misc/NEWS and add stuff.
Bump version number.
2002-07-11 20:50:34 +00:00
Andrew M. Kuchling e995d16f71 Add some items
Expand the "Other Language Changes" section
Rewrite various passages.
2002-07-11 20:09:50 +00:00
Andrew M. Kuchling 7845e7c726 [Bug #567607] Suggest METH_NOARGS to replace PyArg_NoArgs 2002-07-11 19:27:46 +00:00
Fred Drake e4523c46b9 Document gc.get_objects().
Closes SF bug #578308.
2002-07-10 19:21:07 +00:00
Fred Drake 4254cbd29c Note that unicode() can raise LookupError for unknown codecs.
Closes SF bug #513666.
2002-07-09 05:25:46 +00:00
Fred Drake eab5f8a43d Remove unused variable. 2002-07-09 03:24:32 +00:00
Tim Peters 7c321a80f9 The Py_REF_DEBUG/COUNT_ALLOCS/Py_TRACE_REFS macro minefield: added
more trivial lexical helper macros so that uses of these guys expand
to nothing at all when they're not enabled.  This should help sub-
standard compilers that can't do a good job of optimizing away the
previous "(void)0" expressions.

Py_DECREF:  There's only one definition of this now.  Yay!  That
was that last one in the family defined multiple times in an #ifdef
maze.

Py_FatalError():  Changed the char* signature to const char*.

_Py_NegativeRefcount():  New helper function for the Py_REF_DEBUG
expansion of Py_DECREF.  Calling an external function cuts down on
the volume of generated code.  The previous inline expansion of abort()
didn't work as intended on Windows (the program often kept going, and
the error msg scrolled off the screen unseen).  _Py_NegativeRefcount
calls Py_FatalError instead, which captures our best knowledge of
how to abort effectively across platforms.
2002-07-09 02:57:01 +00:00
Fred Drake c6a525e993 Fix typo reported by Kent Engström, and a bunch of broken markup. 2002-07-08 14:42:22 +00:00
Fred Drake 50e1286c00 Fix typo: "an Unicode string" --> "a Unicode string"
Clarify the return value when the parameter is a Unicode object.
2002-07-08 14:29:05 +00:00
Fred Drake 82bac5952f Fixed a typo and updated information about using the Times fonts when
formatting PostScript documents.  Reported by Dave Kuhlman.
2002-07-08 14:10:41 +00:00
Fred Drake 388fba8504 Added font-setting line (and associated comments) to the A4 version of
this file; the lack of this was causing the A4 version of tutorial to
use really bad Type 3 fonts instead of Type 1 fonts, which also
bloated the file size substantially.

I thought there was a SourceForge bug for this, but couldn't find it.
2002-07-08 14:08:48 +00:00
Thomas Heller 291e9ee341 Fix a typo. 2002-07-04 08:36:53 +00:00
Steve Holden b1af86a1d7 Revise asyncore documentation and document asynchat for the first time. 2002-07-03 18:36:39 +00:00
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