490d34dbad
Move license information to a less annoying location in the document.
...
Add documentation for PyErr_SetFromErrnoWithFilename().
2001-06-20 21:39:12 +00:00
d5df09cfb6
Update to include the license information in a less annoying place.
2001-06-20 21:37:34 +00:00
852f7951a2
Separate the copyright statements and license text; include some new
...
comments regarding the history of Python licensing from Guido.
2001-06-20 21:34:35 +00:00
f911a84d5a
Separate the version number and release status into two separate values.
2001-06-20 21:33:13 +00:00
dce975c820
Update to use the newly separated values $PACKAGE_VERSION and $RELEASE_INFO.
...
Normalize all HTML attributes to be written as name="value" instead of
name='value'.
2001-06-20 21:31:36 +00:00
f1927a6d80
Added support for new \setreleaseinfo macro.
...
Normalize all generated HTML so that attribute names come out as
name="value" instead of name='value'.
Changed the target of RFC links to point to the hypertext RFCs at
www.faqs.org instead of the plain text RFCs at www.ietf.org.
2001-06-20 21:29:30 +00:00
c65218e1fd
Add a little more support for describing version information. This
...
is not pretty, but does what is needed.
2001-06-20 21:17:09 +00:00
6016e39250
Document the new encodestring() and decodestring() functions. Also,
...
add some description of what the quotetabs argument does for the
encode*() functions. Finally, add a "see also" pointing to the base64
module.
2001-06-19 19:44:42 +00:00
66eed24415
Add some information on the use of \verbatiminput to display sources from
...
an external file.
2001-06-18 14:59:58 +00:00
fa9e273442
Clarification in the fp appendix suggested on c.l.py by Michael Chermside.
...
Also replaced a *star* style emphasis in the Representation Error section
with an \emph{} thingie.
2001-06-17 21:57:17 +00:00
918f2c722a
Document that filter is added in 2.2.
2001-06-16 08:14:04 +00:00
57e52ef076
Implement the \verbatiminput LaTeX macro; this contains more magic than
...
it should, but only enough that LaTeX2HTML doesn't bite us.
2001-06-15 21:31:57 +00:00
54d10fd2cd
Add a version annotation for the Q and q format codes.
2001-06-15 14:13:07 +00:00
8fcd4b5ab3
Fix an improperly placed comma.
2001-06-14 13:57:16 +00:00
66a0a0a9b6
Make the option processing more robust.
...
Add a -F option similar to "cvs commit -F <file>".
Add a -t option to allow specifying the prefix to the directory into which
the docs should be unpacked (useful when I start trying out new styles for
the presentation).
2001-06-12 13:31:37 +00:00
4a6c5c568f
Fixed reference to table notes for {}.keys() and {}.items() -- these
...
references did not get updated when the notes were renumbered in a
previous update.
This fixes SF bug #432208 .
2001-06-12 03:31:56 +00:00
7a3bfc3a47
Added q/Q standard (x-platform 8-byte ints) mode in struct module.
...
This completes the q/Q project.
longobject.c _PyLong_AsByteArray: The original code had a gross bug:
the most-significant Python digit doesn't necessarily have SHIFT
significant bits, and you really need to count how many copies of the sign
bit it has else spurious overflow errors result.
test_struct.py: This now does exhaustive std q/Q testing at, and on both
sides of, all relevant power-of-2 boundaries, both positive and negative.
NEWS: Added brief dict news while I was at it.
2001-06-12 01:22:22 +00:00
0b9bc20e66
Add the appropriate availability annotations for the popen*() family of
...
functions -- these are not available on traditional Mac OS platforms.
Corrected the version annotations for the spawn*() functions and related
constants; these were added in Python 1.6, not 1.5.2.
2001-06-11 18:25:34 +00:00
046f4d810d
Fixed parameter order for os.popen2(), os.popen3(), and os.popen(4). Added
...
a reference to these functions and popen() from the "Process Management"
section.
Based on a suggestion from comp.lang.python.
2001-06-11 15:21:48 +00:00
c115835457
Fix recent changes so that this section will format again.
2001-06-11 14:55:01 +00:00
7b9542a3f7
Initial support for 'q' and 'Q' struct format codes: for now, only in
...
native mode, and only when config #defines HAVE_LONG_LONG. Standard mode
will eventually treat them as 8-byte ints across all platforms, but that
likely requires a new set of routines in longobject.c first (while
sizeof(long) >= 4 is guaranteed by C, there's nothing in C we can rely
on x-platform to hold 8 bytes of int, so we'll have to roll our own;
I'm thinking of a simple pair of conversion functions, Python long
to/from sized vector of unsigned bytes; that may be useful for GMP
conversions too; std q/Q would call them with size fixed at 8).
test_struct.py: In addition to adding some native-mode 'q' and 'Q' tests,
got rid of unused code, and repaired a non-portable assumption about
native sizeof(short) (it isn't 2 on some Cray boxes).
libstruct.tex: In addition to adding a bit of 'q'/'Q' docs (more needed
later), removed an erroneous footnote about 'I' behavior.
2001-06-10 23:40:19 +00:00
7bc50714fe
Fix the attributions for the new floating point text.
2001-06-08 17:09:01 +00:00
8c27d99941
Added credits in the right places.
2001-06-08 16:28:53 +00:00
417d667dd9
Text from Tim & Guido discussing floating point arithmetic and what users
...
need to understand about the binary & decimal fp, so that representation
weirdness is documented somewhere. This makes it easier to repond to "bug"
reports caused by user confusion & ignorance of the issues.
This closes SF patch #426208 .
2001-06-08 16:24:58 +00:00
1dc98c44fe
add warning about situation where code may be executed twice, once when
...
module is __main__ and once when module is imported.
2001-06-08 14:40:28 +00:00
62f9d7c021
In the section on extending the profiler, add some additional discussion
...
about setting up the dispatch table, and update the OldProfile and
HotProfile classes to the current implementations, showing the adjusted
construction for the dispatch table.
2001-06-08 05:04:19 +00:00
e2ccb89513
Document filter.
2001-06-07 19:01:24 +00:00
2a9bda9223
Typo: "descrition" --> "description"
...
Add reference to the documentation for the Python documentation markup.
Fixed up a couple of descriptions.
This closes SF bug #430627 .
2001-06-06 16:02:47 +00:00
9ccc0df52f
Add references to the documentation for the Python documentation markup.
...
Suggested by the comments in SF bug #430627 .
2001-06-06 15:59:04 +00:00
e24fef0dd2
Fix bug #422702 : Make flag argument to open optional, and document it that way.
2001-06-05 05:33:19 +00:00
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
b9d973dac5
is -> if in rename description
2001-06-04 15:31:17 +00:00
00d0cb6ec3
Explained more differences between PyList_SetItem() and PyList_SET_ITEM().
...
In particular, the affect on existing list content was not sufficiently
explained.
This closes SF bug #429554 .
2001-06-03 03:12:57 +00:00
81e142b907
Document os.getenv().
...
This closes SF bug #429059 .
2001-05-31 20:27:46 +00:00
c19f39272e
Some general cleanup of the threading module documentation, including
...
fixing the reference to Thread.getDeamon() (should be isDaemon()).
This closes SF bug #429070 .
2001-05-31 20:24:07 +00:00
6cba3d0e64
Added entry for HTMLParser documentation.
2001-05-30 04:59:50 +00:00
3b755d43ac
Michel Pelletier <michel@digicool.com>:
...
Documentation for the HTMLParser module, with small changes by FLD.
2001-05-30 04:59:00 +00:00
9a374186fc
New solution to the "Someone stuck a colon in that filename!" problem:
...
Allow colons in the labels used for internal references, but do not
expose them when generating filename.
2001-05-29 19:53:46 +00:00
96a2a80065
Users of PySequence_GET_FAST() should get the length of the sequence using
...
PySequence_Size(), not PyObject_Size(): the later considers the mapping
methods as well as the sequence methods, which is not needed here. Either
should be equally fast in this case, but PySequence_Size() offers a better
conceptual match.
2001-05-29 18:51:41 +00:00
dc9e7e42c8
readlink() description: Added note that the return value may be either
...
absolute or relative.
remove(), rename() descriptions: Give more information about the cross-
platform behavior of these functions, so single-platform developers
can be aware of the potential issues when writing portable code.
This closes SF patch #426598 .
2001-05-29 18:13:06 +00:00
964c074a62
Hack to make this play nicer with *old* versions of Python: os.path.abspath()
...
was not available in Python 1.5.1. (Yes, a user actually tried to use this
with that version of Python!)
2001-05-29 16:10:07 +00:00
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
b9879e1020
Fix typo reported in SF bug #427783 .
2001-05-29 15:44:27 +00:00
c80d4dd695
The parameter to the listen() method is not optional, but was marked as
...
optional in the documentation.
This closes SF bug #427985 .
2001-05-29 15:37:45 +00:00
b2625eb10e
Removed information on the old third parameter to _PyTuple_Resize().
...
Added information on PyIter_Check(), PyIter_Next(),
PyObject_Unicode(), PyString_AsDecodedObject(),
PyString_AsEncodedObject(), and PyThreadState_GetDict().
2001-05-29 15:34:06 +00:00
404ac97207
If the input line does not contain enough fields, raise a meaningful
...
error.
2001-05-29 15:25:51 +00:00
fac312ff88
Do not start API descriptions with "Does the same, but ..." -- actually
...
state *which* other function the current one is like, even if the
descriptions are adjacent.
Revise the _PyTuple_Resize() description to reflect the removal of the
third parameter.
2001-05-29 15:13:00 +00:00
56a71eee65
Add a version annotation for splitdrive(); old, but as long as I managed
...
to end up with the information, it is better recorded than lost.
2001-05-25 16:21:00 +00:00
c6d8f8d2ac
Add descriptions of {}.iteritems(), {}.iterkeys(), and {}.itervalues()
...
in the table of mapping object operations. Re-numbered the list of
notes to reflect the move of the "Added in version 2.2." note to the list
of notes instead of being inserted into the last column of the table.
2001-05-25 04:24:37 +00:00
98cfab6523
One more update related to the new get() and setdefault() methods on the
...
Message object.
2001-05-22 22:00:40 +00:00
6b4593e338
Update to add get() and setdefault() as supported mapping operations, and
...
add a list of the mapping methods which are not supported (per Barry's
comments).
2001-05-22 15:12:46 +00:00
706314909b
Add some clarifications about the mapping interface presented by
...
rfc822.Message objects, based on comments from Barry.
2001-05-22 14:36:30 +00:00
bd695a716d
Changed all the examples with ugly platform-dependent float output to use
...
numbers that display nicely after repr(). From much doctest experience
with the same trick, I believe people find examples with simple fractions
easier to understand too: they can usually check the results in their
head, and so feel confident about what they're seeing. Not even I get a
warm feeling from a result that looks like 70330.345024097141 ...
2001-05-22 06:54:14 +00:00
1400baa5d6
Add a "See also" section with useful links. More should be added giving
...
pointers to information about the other mailbox formats; if anyone can
provide the information needed, please let me know!
2001-05-21 21:23:01 +00:00
8b0b8409ae
Update output to reflect additional precision produced by the repr() of
...
floating point numbers in an interactive example.
Added comment to help explain control flow in the example code showing
how to check if a number is prime.
This closes SF bugs 419434 and 424552.
2001-05-21 16:55:39 +00:00
24e621918b
Add documentation for Py_Main() and PyThreadState_GetDict().
2001-05-21 15:56:55 +00:00
fc43d00c17
Typo: "that" --> "than"
...
This closes SF bug #425320 .
2001-05-21 15:03:35 +00:00
e9719fe1a7
Fix bug in smtplib example: the prompt said to end the message with ^D,
...
but doing so raised EOFError. This makes it work as advertised and
converts to string methods where reasonable.
This closes SF bug #424776 .
2001-05-20 12:26:04 +00:00
09daff4596
Get Aahz listed correctly using his legal/professional name.
2001-05-20 05:29:01 +00:00
3b923fcff5
Add another item
2001-05-19 19:35:46 +00:00
c0dac1a58c
Beef up the unicode() description a bit, based on material from AMK's
...
"What's New in Python ..." documents.
2001-05-15 15:27:53 +00:00
2d9204199f
This patch changes the way the string .encode() method works slightly
...
and introduces a new method .decode().
The major change is that strg.encode() will no longer try to convert
Unicode returns from the codec into a string, but instead pass along
the Unicode object as-is. The same is now true for all other codec
return types. The underlying C APIs were changed accordingly.
Note that even though this does have the potential of breaking
existing code, the chances are low since conversion from Unicode
previously took place using the default encoding which is normally
set to ASCII rendering this auto-conversion mechanism useless for
most Unicode encodings.
The good news is that you can now use .encode() and .decode() with
much greater ease and that the door was opened for better accessibility
of the builtin codecs.
As demonstration of the new feature, the patch includes a few new
codecs which allow string to string encoding and decoding (rot13,
hex, zip, uu, base64).
Written by Marc-Andre Lemburg. Copyright assigned to the PSF.
2001-05-15 12:00:02 +00:00
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
ba7e2c8a27
Add some text to make the dircmp object section more readable, and move
...
some stuff around.
2001-05-11 17:01:32 +00:00
886f113ba9
--sigh--
...
Finish the last set of changes to these files so the conversion does not
break.
2001-05-11 15:49:19 +00:00
47852467f5
Markup adjustments to avoid getting junk in the index.
2001-05-11 15:46:45 +00:00
96d7a70630
Replace "\begin{classdesc}{SomeClass}{\unspecified}" with
...
"\begin{classdesc*}{SomeClass}" -- the rendering of \unspecified was
identical to \moreargs, so this helps clarify things just a little.
2001-05-11 01:08:13 +00:00
9f2376de7a
Document the new classdesc* environment, and the previously undocumented
...
excclassdesc environment.
2001-05-11 01:01:12 +00:00
06a01e84b9
Define a new environment, classdesc*, which can be used to document a
...
class without providing any information about the constructor. This
should be used for classes which only exist to act as containers rather
than as factories for instances.
2001-05-11 01:00:30 +00:00
986badae1e
Write a better synopsis for the Scrap module, and provide a link to
...
useful documentation on the Scrap Manager.
2001-05-10 22:37:38 +00:00
0eeca6342f
Actually include a synopsis line for the ColorPicker module.
2001-05-10 22:36:13 +00:00
e7ec1efe50
Fix typo in weakref.proxy() documentation.
...
This closes SF bug #423087 .
2001-05-10 17:22:17 +00:00
791c351b3d
Update example to no longer use the FCNTL module.
2001-05-10 15:57:17 +00:00
7c116d7acb
Fix typo reported by David Goodger. This closes SF patch #422383 .
2001-05-10 15:09:36 +00:00
e9735ac215
Remove all mentions of the strop module -- it has been pronounced Evil.
...
(The string "strop" is found in the rexec documentation, but that should
not be changed until strop is actually removed or rexec no longer allows
it.)
2001-05-10 15:05:03 +00:00
d0de57cfbb
Update the fcntl module documentation.
2001-05-09 21:09:57 +00:00
bda3a59a93
Itamar Shtull-Trauring <python@itamarst.org>:
...
Updates zipfile.ZipFile docs to mention the fact that you can create a
ZipFile instance from an arbitrary file-like object.
This closes patch #418011 .
2001-05-09 19:57:37 +00:00
b8ac0096b2
Fix the operator precedence table: exponentiation binds tighter than
...
negation.
This closes SF bug #421999 .
2001-05-09 16:51:49 +00:00
251ebe7d30
Remove items that have been done or are being tracked in the SourceForge
...
bug tracker.
2001-05-09 16:43:47 +00:00
283b352d48
Update the directory names to match changes at SourceForge.
2001-05-09 16:33:34 +00:00
c116b82b77
Work around limitations of the module synopsis table generation to avoid
...
leaking LaTeX2HTML's internal string munging.
This fixes SF bug #420399 .
2001-05-09 15:50:17 +00:00
caa79a9ee4
Minor adjustments to HTML for the module synopsis tables.
2001-05-09 15:32:14 +00:00
af922187ae
Job.build_html(): Be more robust in ensuring about.html exists; copying
...
the right HTML file to the name about.html is needed even if the
--numeric option was not given -- some other name may have been
assigned due to some non-determinism in the algorithm use to perform
name allocation. ;-(
This closes the "About..." portion of SF bug #420216 .
2001-05-09 04:03:16 +00:00
a7c9ac6544
There is no IMAP class in the imaplib module; the class is IMAP4.
...
There is no imap module; refer to imaplib instead, since it exists.
Move the "See Also:" section in front of the sub-sections, for
consistency with other portions of the library reference.
This closes the library reference portion of SF bug #420216 .
2001-05-09 03:49:48 +00:00
1ef24e1b30
Note that when inplace=1 existing backup files will be removed silently.
...
Closes SF bug #420230 .
2001-05-09 03:24:55 +00:00
a6140be7b3
Michael Hudson <mwh21@cam.ac.uk>:
...
Documentation update to reflect changes to the termios module (noting
that the termios functions can take a file object as well as a file
descriptor).
This closes the documentation portion of SF patch #417081 .
2001-05-08 05:37:52 +00:00
a8e0827614
Hmm... better add a version annotation for the Iterator Protocol section.
2001-05-07 17:47:07 +00:00
dbcaeda79a
Added documentation for PyIter_Check() and PyIter_Next().
...
Wrapped a long line.
2001-05-07 17:42:18 +00:00
a8defaae04
Skeletal version; I'm checking this in now so I can keep a list of changes,
...
but don't plan on actually writing any text until, ooh, say, July or
thereabouts.
2001-05-05 16:37:29 +00:00
f42cc45f1b
The general iteration support is part of 2.2, not 2.1 -- fixed the version
...
annotations!
Also fixed a typo noted by Neil S.
2001-05-03 04:39:10 +00:00
9cfe1824c2
Add documentation for the StopIteration exception.
2001-05-03 04:30:45 +00:00
287c4cb43a
State that Mailbox objects are iterator objects.
2001-05-02 20:22:12 +00:00
eacdec6b38
Update the filter() and list() descriptions to include information about
...
the support for containers and iteration.
2001-05-02 20:19:19 +00:00
93656e76f9
Added section describing the iterator protocol.
2001-05-02 20:18:03 +00:00
6f15e5796e
Added new parser markers 'et' and 'et#' which do not recode string
...
objects but instead assume that they use the requested encoding.
This is needed on Windows to enable opening files by passing in
Unicode file names.
2001-05-02 17:16:16 +00:00
9188b2194a
Correct two floating-point representations printed by the interpreter in
...
interactive examples. Error noted by Dinu Gherman.
2001-04-25 21:03:20 +00:00
8155e0e541
This patch originated from an idea by Martin v. Loewis who submitted a
...
patch for sharing single character Unicode objects.
Martin's patch had to be reworked in a number of ways to take Unicode
resizing into consideration as well. Here's what the updated patch
implements:
* Single character Unicode strings in the Latin-1 range are shared
(not only ASCII chars as in Martin's original patch).
* The ASCII and Latin-1 codecs make use of this optimization,
providing a noticable speedup for single character strings. Most
Unicode methods can use the optimization as well (by virtue
of using PyUnicode_FromUnicode()).
* Some code cleanup was done (replacing memcpy with Py_UNICODE_COPY)
* The PyUnicode_Resize() can now also handle the case of resizing
unicode_empty which previously resulted in an error.
* Modified the internal API _PyUnicode_Resize() and
the public PyUnicode_Resize() API to handle references to
shared objects correctly. The _PyUnicode_Resize() signature
changed due to this.
* Callers of PyUnicode_FromUnicode() may now only modify the Unicode
object contents of the returned object in case they called the API
with NULL as content template.
Note that even though this patch passes the regression tests, there
may still be subtle bugs in the sharing code.
2001-04-23 14:44:21 +00:00
8b3d6ca3df
At the suggestion of Peter Funk, document 'key in dict' and 'key not
...
in dict' after has_key(), with a \versionadded{2.2} note.
2001-04-23 13:22:59 +00:00
34b48e844e
Update publish-to-SourceForge scripts to automatically determine if the
...
branch is the head (development) branch or a maintenance brach, and use
the appropriate target directory for each.
2001-04-22 06:20:31 +00:00
82f93c693d
Only document <file>.xreadlines() once; added version annotation.
...
This closes SF bug #417943 .
2001-04-22 01:56:51 +00:00
e99b97e58a
encode(): Handle Latin-1 input characters better.
2001-04-21 06:01:53 +00:00
bda05564de
Add support for <memberline/> (needs markup improvement!).
...
Update <versionadded/> to recent addition of optional explanatory text;
make the explanation text take the same attribute name for both
<versionadded/> and <versionchanged/>.
2001-04-21 06:00:51 +00:00
4cacec5393
Fix a number of minor markup errors.
2001-04-21 05:56:06 +00:00
056a71da76
The (fairly recent) \textasciicircum is not supported by LaTeX2HTML; add
...
support for it here.
2001-04-21 05:48:07 +00:00
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
1aec3a16f3
Add versioning notes: many of the signatures changed to allow the time
...
used to be omitted (meaning use the current time) as of Python 2.1.
Users who need cross-version portability need to know things like this.
2001-04-19 04:55:23 +00:00
bc524c4e9f
Cut-&-paste-o noted by Wolfgang Teschner: decompressobj() returns
...
*DE*compression objects, not compression objects!
2001-04-18 20:16:51 +00:00
895aa9da4c
Suggestion from Keith Briggs: refer to RE objects consistently instead of
...
introducing a new term ("regex") without defining it.
2001-04-18 17:26:20 +00:00
f3848322ff
Sync version number with the current CVS version.
...
(Note that the docs are also being maintained on the 2.1.1 maintenance
branch, so users interested only in corrections and clarifications
can get that.)
2001-04-18 05:22:24 +00:00
3151f44d49
Add description of the "explanation" optional parameter added to the
...
\versionadded macro.
Note: this should not be merged into the 2.1 maintenance branch.
2001-04-18 05:19:06 +00:00
4c6f17a537
Make a number of small clarifications and correct a whole bunch of typos,
...
all reported by Bruce Smith.
2001-04-18 05:12:47 +00:00
635a7cfcbb
Sync version number with the current CVS version.
...
(Note that the docs are also being maintained on the 2.1.1 maintenance
branch, so users interested only in corrections and clarifications
can get that.)
2001-04-18 05:02:01 +00:00
293f77af6f
Add note about the version in which GetoptError was added -- this can
...
bite people interested in 1.5.2 compatibility.
2001-04-18 03:18:57 +00:00
c2b29d0fee
Added support for optional explanation parameter to the \versionadded
...
macro.
Refactored do_cmd_versionadded() and do_cmd_versionchanged() to do most
of the work in a helper function, with the do_cmd_*() wrappers just supplying
a portion of the replacement text.
2001-04-18 03:11:04 +00:00
fdfb05bb0b
\versionadded: Add support for including an explanatory note along with
...
the versioning information, similar to \versionchanged.
2001-04-18 03:08:54 +00:00
1fcd438956
Update document for the actual 2.1rc1
2001-04-16 02:27:53 +00:00
3fee30407e
Bump version number and set date.
2001-04-14 18:36:03 +00:00
fc4ee0a296
Add convenience targets that build all archive types for single formatting
...
versions.
2001-04-13 18:00:23 +00:00
8d00a0ffc3
Michael Hudson:
...
Update docs for PyDict_Next() based on the most recent changes to the
dictionary code.
This closes SF patch #409864 .
2001-04-13 17:55:02 +00:00
0c4d468e39
Fixup some platform annotations.
2001-04-13 17:37:00 +00:00
2441366930
Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.
2001-04-13 17:32:49 +00:00
c054c75582
Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.
2001-04-13 17:25:38 +00:00
62effc1127
Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.
2001-04-13 15:55:25 +00:00
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
d20d8b319c
Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.
2001-04-13 14:52:39 +00:00
a3e56a6ceb
Minor markup adjustments.
...
Turn reference to the cmd module into a hyperlink.
2001-04-13 14:34:58 +00:00
e1f3ed6b58
Update the helper scripts that push development docs to SourceForge;
...
this version avoids having to build a separate authenticated connection
to push the update-docs.sh script to SF.
2001-04-13 05:13:55 +00:00
3de33697ef
Add entry for ColorPicker documentation as well.
2001-04-13 04:50:01 +00:00
b6bdcb23df
Documentation for Just's ColorPicker module, so the Mac OS guys get
...
something out of this documentation release as well. ;-)
2001-04-13 04:49:30 +00:00
4f3980d3cb
Added a test main to the pstats library that can help you browse profile dumps.
2001-04-13 00:23:01 +00:00
47f11ce591
Added warning that FancyURLopener prompts the user on the terminal when
...
basic authentication is needed.
Added documentation for FancyURLopener.prompt_user_passwd(), explaining
that subclasses should provide more appropriate behavior for the hosting
environment.
2001-04-12 20:26:49 +00:00
62a26699c4
Added module synopsis for the chapter summary.
...
Added documentation for TestCase.assertRaises().
Added text for "Mapping concepts to classes", and merged it into the
front matter instead of separating it into a new section.
Removed use of "assert" in examples.
Update the descriptions to reflect further changes from discussions on
the pyunit-interest list.
Added documentation for the defaultTestLoader object and the
TestLoader methods.
Added the assert*() names for the TestCase helper methods.
2001-04-12 19:34:38 +00:00
e20bd19f86
Convert several \seetext references to \seerfc and \seetitle versions.
...
These format somewhat better and include more semantic information in the
source.
2001-04-12 16:47:17 +00:00
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
0056a427bb
Added a lot of text from Steve Purcell's HTML documentation.
...
Updated reference material substantially based on discussions on the
pyunit-interest mailing list (not all changes are in the code in CVS
yet).
2001-04-12 04:50:06 +00:00
c790e08ac1
Use "2.1c1" since that is what Guido used for the Python version number.
2001-04-12 04:34:26 +00:00
0c14961872
Update to reflect the new string repr -- \n instead of \012. This is the
...
only documentation file that appears to be affected by the change!
2001-04-12 04:26:24 +00:00
9ad526fac3
Markup nit: use \envvar to mark environment variables.
2001-04-12 04:11:21 +00:00
e0197bfaeb
When forming the <A> tag for a \seepep or \seerfc, make sure we strip
...
HTML markup from the string used as the title in the TITLE attribute.
This fixes formatting in the "What's New in Python 2.1" document.
2001-04-12 04:03:22 +00:00
db7657d4e0
Explain popitem()
...
Add Unixware 7 port
Ready for RC1
Minor rewrites
2001-04-12 03:37:19 +00:00
b942c2f788
Fixed bug in example.
...
This closes SF bug #415522 .
Also fix markup error in text following the example.
2001-04-11 21:33:47 +00:00
c3cbbaf513
Added some additional documentation describing how BabylMailbox
...
actually works (it returns a message containing the visible headers,
not the original headers). Doc change approved by Fred; closes SF bug
#412230 .
2001-04-11 20:12:33 +00:00
eedf985056
Include a synopsis for the chapter overview.
2001-04-11 19:17:11 +00:00
2bd0d88360
Fixing bug 405999 -- clarifying differences between Python's
...
getopt and GNU getopt -- Python is like classical UNIX getopt.
2001-04-11 07:33:08 +00:00
5d6e402e0c
Based on a comment by Konrad Hinsen on python-list:
...
Change "EOF" to "end-of-file", on the premise that it is easier for
new programmers to understand (at least a little).
This does not attempt to explain "file or device attached to standard
input."
2001-04-11 04:38:34 +00:00
29be70195a
Added definition of "test fixture".
...
Added description of optional parameter to the TestSuite constructor.
Added descriptions of the TestLoader and TextTestRunner classes.
Added method descriptions for the TestCase class.
2001-04-10 22:25:06 +00:00
8875c86a12
Typo: "BuildApple" --> "BuildApplet"
...
Added reference to the webbrowser module from the nsremote description.
2001-04-10 20:32:16 +00:00
c5287ac66a
Bump version numbers for upcoming release candidate.
2001-04-10 20:19:25 +00:00
20931fb3f4
Update the XML conversion specification.
2001-04-10 19:59:31 +00:00
ac154a17a3
Remove the mapping() function from the documentation.
...
Add a description of the ReferenceError exception.
2001-04-10 19:57:58 +00:00
da00cda9fa
Add note that difflib was added in Python 2.1.
2001-04-10 19:56:09 +00:00
cfac6d23fd
Normalize tabs to spaces.
...
Update the attribution for the "Curses Programming with Python" How-To.
Change the way the reference to the Demo/curses/ directory is marked up.
2001-04-10 18:49:09 +00:00
6fda3ac474
Add reference to the DDJ article discussing a similar algorithm.
2001-04-10 18:41:16 +00:00
86333606f6
Add corresponding support for the alltt environment to the HTML generator.
2001-04-10 17:13:39 +00:00
b5309a956e
Import the alltt package and wrap that environment in a similar way to
...
the way we handle verbatim, so that it picks up the same indentation and
minipage behavior.
2001-04-10 15:53:06 +00:00
90a72f8dcd
Add documentation for getmoduleinfo() and getmodulename().
2001-04-10 15:12:34 +00:00
697c9c9c71
In the typeset versions, the legal notices had grown past the one-page
...
size. This constrains them to fit in one page again.
2001-04-10 05:26:29 +00:00
819815abea
Fix typo in example (\b should be \n in string literal).
...
This closes SF bug #414279 .
2001-04-09 15:57:06 +00:00
9c846366ee
Fix a number of bugs and omissions in the AddressList documentation, most
...
noted by Steve Holden.
This closes SF bug #413876 .
2001-04-09 15:42:56 +00:00
4d4d0034c0
Correct the documentation for getreadbufferproc and getwritebufferproc.
...
Fixes bug #233308 from Travis Oliphant.
2001-04-07 16:14:49 +00:00
501d90471d
Add entry for unittest documentation.
2001-04-07 05:42:14 +00:00
b9ad228798
Start of documentation for the unittest module. Some of this comes from
...
Steve Purcell's documentation, and a lot of it is written based on
using PyUnit and reading the implementation.
There is more to come, but I want to get this check in before I have a
disk crash or anything else bad happens.
2001-04-07 05:41:39 +00:00
4cf1227e56
Change {\em ...} to \emph{...} for consistency with the rest of the Python
...
documentation.
2001-04-05 18:31:27 +00:00
f459d852e5
Add some information about what to expect of the DocumentType's
...
.internalSubset attribute based on a clarification from the www-dom
list.
2001-04-05 18:30:04 +00:00
c6a3cb4baf
Document PySequence_Size(), and describe PySequence_Length() as simply an
...
alternate name for the same function.
2001-04-04 01:25:17 +00:00
979d041b6f
Make reference to the Library Reference in the "What Now?" chapter a
...
hyperlink.
Fix two English usage errors caught by Jan Wells: Changed "subsequence"
to "sub-sequence" in two places, and avoid improper use of "hopefully" in
the first paragraph of the "What Now?" chapter.
2001-04-03 17:41:56 +00:00
c81d470648
Allow the <author/> element to appear before a paragraph without being
...
made a part of the paragraph.
2001-03-29 23:31:22 +00:00
659f377ed9
Add entry for curses.panel documentation.
2001-03-29 22:23:19 +00:00
14631f674f
Fix serious markup errors.
2001-03-29 22:22:23 +00:00
c612a14e9e
Remove the spurious space of uncertain origin from the output for function,
...
method and constructor signatures. Suggested by Peter Funk on the Doc-SIG
mailing list.
2001-03-29 18:24:08 +00:00
cb83988151
Added example use of weak references, contributed by Tim Peters.
2001-03-28 21:15:41 +00:00
58c8f9f631
Added documentation for PyObject_IsInstance() and PyObject_IsSubclass().
2001-03-28 21:14:32 +00:00
e2645775d1
Typo: "ariables" --> "variables"
...
This fixes SF bug #411118 .
2001-03-28 16:55:53 +00:00
2bbc6974d0
Fix a number of small issues; this closes SF bug #411063 .
2001-03-28 16:51:20 +00:00
21e036ccca
Add a note that the "kfm" controller supports "konqueror" as well as the
...
old KDE 1 "kfm" command.
2001-03-26 16:17:21 +00:00
4240bc50f6
Note missing explanation
2001-03-26 13:34:53 +00:00
c8da0f966f
Document use_rawinput. (Although now that I think more about it, a
...
better solution would have been to factor out the raw_input() call and
make it into an overridable method. Oh well, maybe later...)
2001-03-24 19:17:35 +00:00
8f6df46d40
Strengthen the constraints on calling PyObject_GC_Fini().
2001-03-23 17:42:09 +00:00
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
7190247e0b
Remove the annoying __version__ definitions.
2001-03-23 17:09:02 +00:00
3e8f921fb9
Lots of small changes to make this work with the Python DOM bindings
...
(minidom in particular); it was using PyDOM which is now obsolete.
Only write the output file on success -- this avoids updating the timestamp
on the file on failure, which confuses "make".
2001-03-23 17:01:47 +00:00
2262a80fb3
Pick up the "encode" function from esistools instead of defining our own
...
(broken) version.
Remove Conversion.err_write() -- use dbgmsg() consistently.
2001-03-23 16:53:34 +00:00
a9d0450f72
No quotes around the "future" in the first use of the term "future
...
statement".
2001-03-23 16:47:11 +00:00
f6c115ff2f
Re-write to no longer depend on an old version of PyXML. This now
...
implements a SAX XMLReader interface instead of the old Builder interface
used with PyDOM (now obsolete).
This only depends on the standard library, not PyXML.
2001-03-23 16:42:08 +00:00
a4699a71b8
Pick the "escape" function from the standard library instead of from PyXML.
2001-03-23 16:38:12 +00:00
ce19496ec1
Add conversions for more of the markup -- not all of this was around when
...
this file was written!
2001-03-23 16:29:06 +00:00
7621fa9147
Add entry for the futures appendix in the reference manual.
...
Correct the comment at the top of the file.
2001-03-23 16:23:21 +00:00
557c1ae150
Include the futures appendix.
2001-03-23 16:21:15 +00:00
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
324cc6ee0e
Add some initial text for the appendix on future statements and nested scopes.
2001-03-23 15:29:54 +00:00
2c84fc8a7d
Note that assignments to __debug__ are illegal
2001-03-23 14:34:06 +00:00
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
16a0b17460
Bump version number.
2001-03-23 12:12:05 +00:00
ce7298ab42
Explain the difference between NL and NEWLINE.
2001-03-23 05:22:12 +00:00
c608fb6389
Give a slightly better explanation of excepthook.
2001-03-23 05:17:41 +00:00
5e0dfaccd1
Update to the most recent weakref changes.
2001-03-23 04:36:02 +00:00
ac1abe0bfe
Add a paragraph about obmalloc turning up bugs in extension modules
...
Mention the new ports
2001-03-23 03:52:46 +00:00
ef85cc84a0
Add section for PEP 241
...
Add PyUnit and sys.excepthook
2001-03-23 03:29:08 +00:00
b5c5132d1a
Add sys.excepthook.
...
Update docstring and library reference section on 'sys' module.
New API PyErr_Display, just for displaying errors, called by excepthook.
Uncaught exceptions now call sys.excepthook; if that fails, we fall back
to calling PyErr_Display directly.
Also comes with sys.__excepthook__ and sys.__displayhook__.
2001-03-23 02:46:52 +00:00
6909642d38
Bump the version number.
2001-03-22 17:01:43 +00:00
15e07f4442
Update to the current state of the universe.
2001-03-22 17:00:05 +00:00
e28d8aef2d
Be more clear about the specific rules for supporting the cyclic GC in an
...
extension object. Also included an example showing exactly what needs to
be done and nothing else.
This closes SF bug #228591 .
2001-03-22 16:30:17 +00:00
c392b570db
Integrated an expanded version of some text from Neil Schemenauer about
...
supporting cyclic garbage collection. (This is not all of it, but I'm
taking a break!)
Also fixed some markup nits.
2001-03-21 22:15:01 +00:00
4e6d09e369
Moved the description of the tzparse module to the "Obsolete" section
...
and note that it fails when the TZ environment variable is not set.
This closes SF bug #409683 .
2001-03-20 23:13:53 +00:00
f531ad698c
Markup nit: For the Python documents, we use \empt instead of \textit.
2001-03-19 04:19:56 +00:00
b15bbc8d3d
Add documentation for SGMLParser.handle_decl().
2001-03-16 20:39:41 +00:00
83e01bf6c8
Finally fill in the documentation for the PyDict_Next() function. It is
...
different enough to actually require an explanation. ;-)
Fix a couple of PyDictObject* types that should be PyObject* types.
2001-03-16 15:41:29 +00:00
1b0b2a4df2
Add some LaTeX magic so that Latin-1 characters do not get so badly
...
trashed.
2001-03-13 17:56:08 +00:00
93fe96a3c8
Py_BuildValue(): Add "D" conversion to create a Python complex value from
...
a Py_complex C value.
Patch by Walter Dörwald.
This closes SF patch #407148 .
2001-03-12 21:06:31 +00:00
45bbda2593
Fix a further markup problem noted by FLD
2001-03-10 16:49:07 +00:00
f0ebbe0bd0
Re-order some method descriptions for a more logical grouping.
...
(Based on reader comment!)
2001-03-08 22:46:41 +00:00
9eb41557ef
Add more font flavors for <var> elements; the previous incarnation caused
...
some NT/IE5.5 users to see only boxes for these characters. This might be
specific to NT Service Pack 6.
2001-03-08 22:17:54 +00:00
859eb62108
Do not refer to "sub-modules" since that is not a defined term.
2001-03-06 07:34:00 +00:00
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
ce7129ea4e
Turn "Python Documentation Central" into just "Documentation Central"; some
...
Web browsers tried to wrap lines in bad ways, so we avoid the problem by
putting fewer words on the page.
2001-03-06 07:28:20 +00:00
2636572d76
Make sure the README files that contain page count information land in
...
the right directory (which actually exists).
2001-03-06 07:22:16 +00:00
67fdaa4883
Correct typos in Ping's email address.
...
Remove premature use of negative indexes in string operation examples;
negative indexes have not been explained at that point, and the use of
negative indexes are not necessary for the examples.
2001-03-06 07:19:34 +00:00
990b0fec1a
Update documentation to reflect the shift to NetrcParseError instead of
...
SyntaxError.
2001-03-06 06:55:18 +00:00
0c8f6643c6
Remove debugging "set -x".
2001-03-03 19:57:26 +00:00
42119e49a9
Fix a few minor markup nits.
2001-03-03 19:47:24 +00:00
6be838a0c0
Rene Liebscher <R.Liebscher@gmx.de>:
...
Added information on using non-Microsoft compilers on Windows.
[Minor edits for markup consistency. --FLD]
2001-03-03 19:18:01 +00:00
61af5605fa
Discuss PEP 236.
...
Update nested scope section.
2001-03-03 03:25:04 +00:00
81df7be2a2
Update estimate bug and patch counts
2001-03-02 21:19:38 +00:00
3f4e717c31
Revise the scripts I use to update the documentation on the SourceForge
...
site. These now seem (slightly) more reliable, and easier to work with
since update-docs.sh no longer needs to be installed ahead of time on
my account at SF.
2001-03-02 21:05:58 +00:00
93c867139f
Lots of organizational changes for consistency with the rest of the
...
documentation.
Fix a few small markup nits.
2001-03-02 20:39:34 +00:00
80d4c07775
There was a real leak in the "export a C API" example; fix that one.
...
(There are too many initspam() functions; they need to be renamed
post-beta.)
2001-03-02 19:48:06 +00:00
ab357ecf7f
Label classes and exceptions explicitly in the documentation (for their
...
*desc environments).
2001-03-02 18:57:05 +00:00
0539bfaaa4
There is no longer a -X option to the interpreter, so remove the comments
...
on how PyErr_NewException() behaves in that case.
Clarify why an owned reference is kept in an extension module's
variable that refers to the result of PyErr_NewException(); one reader
thought that was a leak.
Clean up some tabs and simplify some markup.
2001-03-02 18:15:11 +00:00
043d5e5514
For copyfile(), be explicit that src and dst are file names; that was only
...
implied.
2001-03-02 16:46:42 +00:00
cfef0096f9
Job.build_html(): When formatting HTML into more than one HTML page, and
...
not doing the \label{foo} --> foo.html transformation (--numeric was
specified on the command line), still look to see if there is an
"About this document..." node and copy that to "about.html", since the
page footers use that as the target.
2001-03-02 16:26:45 +00:00
7606e4d00e
Added entry for urllib2 documentation.
2001-03-01 19:54:29 +00:00
8c011580ff
Use larger chunks for the HTML version of the Distutils documentation.
2001-03-01 18:38:56 +00:00
a9a83e9ee3
Comment out section titles for sections that have not been written yet;
...
there is no need to clutter a reader's life with those useless things.
Suppress the "Contents" page for HTML; it is not needed for small documents
in the online environment since LaTeX2HTML generates lots of tables of links
anyway.
Various markup consistency nits.
2001-03-01 18:37:52 +00:00
a09262e860
Comment out section titles for sections that have not been written yet;
...
there is no need to clutter a reader's life with those useless things.
Make the snippets of Python code conform to the standard style.
Suppress the "Contents" page for HTML; it is not needed for small documents
in the online environment since LaTeX2HTML generates lots of tables of links
anyway.
Various markup consistency nits.
2001-03-01 18:35:43 +00:00
f89ad5ed6b
Document configuration flags to compile for large file support on
...
certain Linux systems.
2001-03-01 18:29:57 +00:00
8a18e99008
Checking in patch 404826 -- urllib2 enhancements and documentations.
...
(please not that the library reference does *not* include the
urllib2 documnetation -- that will wiat for Fred)
2001-03-01 08:40:42 +00:00
baee0d42c9
Bump the release number to 2.1b1.
2001-03-01 06:01:20 +00:00
694e1816c2
Fix markup nit pointed out by FLD
2001-03-01 01:02:52 +00:00
1874c8f23b
Document PyErr_WarnExplicit().
2001-02-28 23:46:44 +00:00
56ba72a563
Document warn_explicit().
2001-02-28 23:34:21 +00:00
7840a9cb99
Add entry for the inspect module.
2001-02-28 23:02:20 +00:00
6dbd382ec8
Clean up some of the markup for consistency, wrap some long lines.
2001-02-28 23:01:38 +00:00
bca60c07b3
Fix some rules broken by typos, others by the flattening of the makefile.
2001-02-28 22:59:37 +00:00
8bad993dd3
Add description of PEP235
...
Remove references to 2.1alpha
Update description of PEP229
2001-02-28 22:39:15 +00:00
74d18ed076
Cover pydoc
...
Update reference Python version to beta1
Rip out PEP 232 section
Add placeholders for PEP 236 and 235
Fix erroneous \filename references
2001-02-28 22:22:40 +00:00
bf140147d8
Document the object allocator
...
Minor sentence change
2001-02-28 22:10:07 +00:00
58177b9975
added description of NL token
2001-02-28 22:05:41 +00:00
969ab2710a
Update documentation for termios module; do not refer to the TERMIOS module
...
for constant definitions.
Add a deprecation to the TERMIOS module.
2001-02-27 22:01:15 +00:00
5e1633365d
Patch #403985 : Add support for weak-keyed dictionaries
2001-02-27 18:36:56 +00:00
6397c7c9a9
inspect: a module for getting information out of live Python objects
2001-02-27 14:43:21 +00:00
Fred Drake
Barry Warsaw
Tim Peters
Martin v. Löwis
Skip Montanaro
Andrew M. Kuchling
Marc-André Lemburg
Guido van Rossum
Eric S. Raymond
Moshe Zadka
Greg Stein
Jeremy Hylton
Ka-Ping Yee