66571cc20c
Improve a couple of references to the language reference, making them
...
hyperlinks to relevant sections.
Clarify the conditions under which the "softspace" attribute of file-like
objects can "just work" (with relation to overriding of attribute access
in user-defined classes).
2000-09-09 03:30:34 +00:00
7acb21866c
Minor clarifications in the introductory paragraph.
2000-09-09 03:28:00 +00:00
e544191397
Add \modulesynopsis for inclusion in the list of modules at the beginning
...
of the chapter.
Add explanation that this is only available when the cycle detector is
enabled at build time.
2000-09-09 03:26:51 +00:00
1c4efad770
Move the "See also" section to a location more consistent with other
...
module sections. Properly mark the name of the module in the content
of the reference there.
2000-09-09 03:25:11 +00:00
621d2bee1c
Move description of UserString.MutableString to a location more typical
...
of the arrangement of other modules.
2000-09-09 03:23:50 +00:00
d0726c3cd9
\file is not allowed in section titles -- converting to PDF fails due to
...
weird macro-expansion issues. A better solution may be available in the
future, but this will do for now.
Add an index entry. More should probably be added as well.
2000-09-07 18:55:08 +00:00
88c023b863
Remove comment about -X and string exceptions. Error noted by
...
Justin D. Pettit <jpettit@raznick.com>.
2000-09-07 16:33:32 +00:00
6300bd42a4
Added note about Python version this was added for.
2000-09-07 14:01:40 +00:00
77a6c9ece5
Minor markup nits around use of \optional.
2000-09-07 14:00:51 +00:00
8b2e8f846c
Added a \versionadded statement to the getfqdn() description.
2000-09-06 02:22:16 +00:00
8ff4cd7512
Minor markup revisions for consistency with the rest of the documentation.
2000-09-05 13:50:21 +00:00
0d83f68fc9
Added entry for mmap module.
2000-09-05 13:49:30 +00:00
21fbd540ed
Document the new optional argument "rest" on the transfercmd(),
...
ntransfercmd(), and retrbinary() commands. This closes SF patch
#101187 .
2000-09-01 06:32:32 +00:00
65faf118b6
Fix markup error and minor consistency nit.
2000-08-31 19:35:56 +00:00
ee5adfbae6
add user-modifiable recursion_limit
...
ceval.c:
define recurion_limit (static), default value is 2500
define Py_GetRecursionLimit and Py_SetRecursionLimit
raise RuntimeError if limit is exceeded
PC/config.h:
remove plat-specific definition
sysmodule.c:
add sys.(get|set)recursionlimit
2000-08-31 19:23:01 +00:00
aef0e890b5
Document the limitation that urllib does not work with proxies which
...
require authenication. This is an implementation limitation rather than
required behavior, and may be fixed in the future.
This closes SourceForge bug #111725 .
2000-08-31 17:23:35 +00:00
4c3f797128
UNARY_NEG is supposed to be UNARY_NEGATIVE (spotted by Charles Waldman
...
<cgw@fnal.gov>).
Fix minor problem with EXTENDED_ARG description markup..
2000-08-31 16:26:35 +00:00
1c8feae411
New method getnamespace.
...
Since the application never gets to see the namespace abbreviation
used in the XML document, but some applications may need to know them,
we provide this method.
2000-08-31 10:27:00 +00:00
fcab76350a
Relocate the popen2 documentation since it is now substantially more
...
portable.
2000-08-31 06:09:26 +00:00
7b828a6a56
doc changes to parallel changes to calendar.py module
2000-08-30 14:02:25 +00:00
d576e9df5f
Markup revisions. Nothing was actually required to be able to format it,
...
but many conventions were broken.
2000-08-30 04:19:20 +00:00
28b815f28a
Oops, spell MAL's name right.
2000-08-30 03:28:17 +00:00
0691a6b8ed
Documentation for the gettext module.
2000-08-30 03:27:10 +00:00
058365aec5
Added libgettext.tex
2000-08-30 03:26:17 +00:00
a1a4b5916b
Closing patch #101120 -- After everyone agreed.
2000-08-25 21:47:56 +00:00
0308ff8652
Add reference to RFC 2396 in "See also" section.
...
Minor cleanups.
2000-08-25 17:29:35 +00:00
dfca4dc503
Revised documentation relevant to SourceForge patch #100837
...
(simplify making HTTP POST requests).
Added documentation of URLopener.version and how it can be overridden.
2000-08-25 05:13:42 +00:00
99a3701618
Documentation for poll() interface (SF patch #100852 )
2000-08-25 01:21:28 +00:00
12bba852a9
Rough and incomplete documentation on augmented assignment, which follows
...
shortly. Markup also needs checking.
2000-08-24 20:06:04 +00:00
3d0c77b37c
Addresses the other half of Bug #112634 -- the documentation suggested
...
that you can set self.version *after* calling the base class __init__.
In fact it must be done *before*.
(Fred, maybe the version class variable should be documented now?)
2000-08-24 16:20:32 +00:00
45ca3331d9
Move references to RFCs to a "See also" section for consistency with
...
other sections of the library reference.
2000-08-24 04:58:25 +00:00
9fa4d61bcc
Moshe Zadka <moshez@math.huji.ac.il>:
...
Documentation updates for urlretrieve() and URLopener.retrieve(), to
reflect Randall Hopper's patch for those functions.
This closes SourceForge patch #100837 .
2000-08-24 01:06:40 +00:00
093272ea85
Charles G. Waldman <cgw@fnal.gov>:
...
Update the dis module documentation to reflect the EXTENDED_ARG opcode.
2000-08-24 00:37:50 +00:00
297bf7ceb5
update commonprefix doc to make sure user is aware it works
...
character-by-character and that that behavior may result in it returning
prefixes that are not valid paths
2000-08-23 16:58:32 +00:00
9087688581
Describe the new PRINT_ITEM_TO and PRINT_NEWLINE_TO opcodes.
2000-08-21 17:19:00 +00:00
120beb6b67
Strengthen the warning against using SerialCookie and SmartCookie.
...
(If they're security holes, should they be documented at all?)
Minor rewrites.
2000-08-20 23:33:50 +00:00
15446d344d
Add entry for Cookie module.
2000-08-19 16:55:31 +00:00
e5c7352201
Make it format.
...
Adjust markup for hyperlinking to the relevant RFCs.
Give it a little organization.
Minor nits.
2000-08-19 16:54:57 +00:00
1b07f2bcf6
Initial revision. Markup unchecked.
2000-08-19 14:11:41 +00:00
512bb72fb0
As pointed out by Denis S. Otkidach <den@analyt.chem.msu.ru>, xrange()
...
returns an xrange object, not a range object, despite the name of the
source file they're implemented in.
In the list of comparison operators, list != before <>, since <> is
described as obsolescent.
2000-08-18 03:12:38 +00:00
304faf944c
Fix a markup error that caused formatting to fail.
...
Lots of minor markup adjustments as well.
2000-08-18 02:15:55 +00:00
0690c86a2a
Document the returns_unicode attribute
2000-08-17 23:15:21 +00:00
5215225ea1
Apply SF patch #101135 , adding 'import module as m' and 'from module import
...
name as n'. By doing some twists and turns, "as" is not a reserved word.
There is a slight change in semantics for 'from module import name' (it will
now honour the 'global' keyword) but only in cases that are explicitly
undocumented.
2000-08-17 22:55:00 +00:00
dd611b0070
A little more text, and some really minor cleanups.
2000-08-17 22:31:23 +00:00
e581bb30c4
Small cleanups, and note when zip() entered the menagerie.
2000-08-17 22:30:30 +00:00
b32aa5ecef
Revise the comments about the exceptions module to not refer to source
...
code; it is not sufficiently readable now that it in written in C, and
is less likely to be available to end users.
2000-08-17 22:29:31 +00:00
25699f99f4
Martin v. Loewis <martin@loewis.home.cs.tu-berlin.de>:
...
Document opcodes added to support extended call syntax.
2000-08-17 22:19:26 +00:00
5772c86816
Document socket.getfqdn().
2000-08-16 14:21:42 +00:00
caa658d047
Apply SF patch #101151 , by Peter S-K, which fixes smtplib's passing of the
...
'helo' and 'ehlo' message, and exports the 'make_fqdn' function. This
function should be moved to socket.py, if that module ever gets a Python
wrapper.
2000-08-15 19:30:36 +00:00
d066f6d780
Fix markup bug that prevented formatting.
...
Adjusted some markup for consistency with the rest of the documentation
and creation of the proper index entries.
2000-08-15 17:47:09 +00:00
0be4346da6
Describe the b2a_hex() and a2b_hex() functions (a.k.a. hexlify() and
...
unhexlify() respectively).
2000-08-15 06:08:00 +00:00
4ef4be53ac
Added description of the md5.hexdigest() method.
2000-08-15 06:00:28 +00:00
a2b6ad6e27
Guido pointed out that all names in the sys module have no underscore,
2000-08-15 04:24:43 +00:00
68e2915fc7
Document the byte_order value in the sys module.
2000-08-14 15:47:30 +00:00
107b9679c4
Document the range type, as suggested by Denis S. Otkidach
...
<den@analyt.chem.msu.ru>.
2000-08-14 15:37:59 +00:00
4de96c2fd8
Added Marc-Andre Lemburg's documentation for string methods, with some
...
massaging for markup consistency. This closes SourceForge patch #101063 .
Added Unicode strings and buffer objects to the list of sequence types.
Small markup nits elsewhere.
2000-08-12 03:36:23 +00:00
0be5aab04d
Merge UNPACK_LIST and UNPACK_TUPLE into a single UNPACK_SEQUENCE, since they
...
did the same anyway.
I'm not sure what to do with Tools/compiler/compiler/* -- that isn't part of
distutils, is it ? Should it try to be compatible with old bytecode version ?
2000-08-11 22:15:52 +00:00
46479d3740
Some minor clarifications and added some index entries.
2000-08-11 20:34:27 +00:00
3ac977e39c
O_BINARY: Documented this constant; omission noted by David Ascher.
...
access(): Corrected availability statement; error pointed out by
Tim Peters.
2000-08-11 20:19:51 +00:00
a8e484c8f5
getopt(): revise description of long_options parameter slightly so it will
...
be less confusing; add a paragraph separation so that comments about
the options and long_options parameters don't have references that
are easily misinterpreted.
Adjust the interactive examples to not need the string module.
Add an example showing how the module is commonly used in a script.
2000-08-11 19:55:06 +00:00
10e1bf2f64
remove all occurence of math.rint() from the sources
...
(and yes, "Currintly" also counts <0.5 wink>)
2000-08-10 04:23:30 +00:00
65983372f0
More on noutrefresh.
2000-08-09 21:49:31 +00:00
1ebd3f6c4b
Tweak curses.wrapper so it initializes colors if they are available.
2000-08-09 21:11:07 +00:00
3fe9a98c95
Correct markup error.
2000-08-09 14:37:05 +00:00
fc1f9229f4
Correct version number at which the curses.ascii module was introduced.
2000-08-09 14:36:11 +00:00
ec4b2af6bb
Fix a few markup errors and lots of small consistency issues.
...
Add "See also" link to curses.wrapper module from curses module.
2000-08-09 14:34:48 +00:00
8141cf5c76
Barry's patch to document the new setdefault() method. Slightly
...
clarified the summary for default() in the table to indicate the side
effect.
2000-08-08 16:15:49 +00:00
f9d20c3786
Neil Schemenauer: GC enable(), disable(), isenabled() interface.
...
Small stylistic changes by VM:
- is_enabled() -> isenabled()
- static ... Py_<func> -> static ... gc_<func>
2000-08-06 22:45:31 +00:00
5a007693c1
Documented curses.wrapper and curses.textpad.
2000-08-04 07:35:41 +00:00
ed13b4a5a6
Break the "Python Services" chapter into two: "Python Runtime Services"
...
(still at the start of the manual), and "Python Language Services" (late
in the manual). Moved "Restricted Execution" to just before "Python
Language Services."
2000-08-03 21:18:18 +00:00
8b168ba505
int() description: Fix markup to avoid image generation for math mode.
...
zip() description: Fix broken markup, three small markup consistency nits,
and one really minor usage nit. Introduce use of \moreargs instead
of hardcoding "..." with \optional.
2000-08-03 17:29:13 +00:00
faefa2a885
Both PEP 201 Lockstep Iteration and SF patch #101030 have been
...
accepted by the BDFL.
Added documentation for zip() builtin.
2000-08-03 15:46:17 +00:00
6c7a46a2f0
Rob Hooft <rob@hooft.net>:
...
Description of fcntl(): Added description of what can go wrong.
2000-08-02 20:53:51 +00:00
21a4764b9a
As requested by Fred - mention that in the future a winreg module may make a comeback.
2000-08-01 23:49:50 +00:00
f917bf6080
fixing a minor spelling mistake
2000-08-01 00:07:17 +00:00
fbd3b45bb7
Stop lying about [].pop() being experimental! There is no backing it out
...
at this point.
2000-07-31 23:42:23 +00:00
5a65c2d436
added count, extend, index, pop and remove to arraymodule
2000-07-31 20:52:21 +00:00
1e75e1776f
Two minor nits from Gerry Weiner (no working email address) about
...
describing the methods of dictionaries.
2000-07-31 16:34:46 +00:00
578a3f9638
Moshe Zadka <mzadka@geocities.com>:
...
Document new method in shutil (copyfileobj).
Minor clarification by Fred.
2000-07-31 15:45:46 +00:00
10853c9835
Finally fixed the much-reported bug about "~" in a couple of example.
...
This time, it was reported by Skip.
2000-07-28 13:51:27 +00:00
b924bd4610
Second round of curses documentation improvements. Completes and extends
...
documentation for function keys, special characters.
2000-07-27 21:10:02 +00:00
1962fb59f3
Document tiget{flag,num,str}
2000-07-26 02:59:13 +00:00
e1b304db37
Fix small typos and markup consistency nits.
2000-07-24 19:35:52 +00:00
6899660a81
First round of curses documentation improvements; correct errors, flesh out
...
entry point descriptions.
2000-07-24 03:28:40 +00:00
d372521ec0
added doc for isatty()
2000-07-19 17:30:58 +00:00
7cb1524586
added documentation for new functions {get,set}_history_length
2000-07-19 16:56:26 +00:00
f8316638af
Rob W. W. Hooft's spelling fixes for the Library Reference. I hope
...
SourceForge doesn't choke on this batch :-)
I'm not entirely sure this is 100% correct. The patch changes an
\index{persistency} to \index{presistence}, and I don't know what \index{}
does. But it seems to do so persi--er, consistently, so I hope it isn't a
problem.
2000-07-16 19:01:10 +00:00
f868de6491
Document the second round of ConfigParser changes.
2000-07-14 15:00:02 +00:00
8d2f2b2db2
From Sam Rushing's Medusa, via SF patch #100858 : add & document
...
os.seteuid(), os.setegid(), os.setreuid(), os.setregid().
2000-07-13 01:26:58 +00:00
bdcf91fda0
Documentation for the gc module. Text from Neil Schemenauer
...
<nascheme@enme.ucalgary.ca>, markup & minor revisions from Fred
Drake.
2000-07-12 04:22:53 +00:00
7ae3a5e79d
Resynchronize the TeX docs with (a) the module docstring, and (b) my recent
...
fix to the code to make it behave like the module docstring.
2000-07-12 02:56:15 +00:00
acab3d61e9
Change the table in the pyexpat.errors module to a series of datadesc
...
elements (since the table was pretty screwed up); this is how it is done
elsewhere in the manual.
I could use some help creating descriptions of the specific error
identifiers (input conditions that lead to each error, etc.).
2000-07-11 16:30:30 +00:00
417c489def
Give ConfigParser the capability to set as well as read options, and to write
...
a representation of the configuration state in .ini format that can be read
back in by a future read() call. Thus this class is now a back end
for .ini editors as well as parsers.
This patch is complete and tested, but exposes a bug in the ConfigParser
implementation which I have not yet fixed. Because case information is
discarded during parsing, the output of write() has its case smashed.
I wrote this for a SourceForge interface script called forgetool.
Documentation for the new entry points included.
2000-07-10 18:11:00 +00:00
146b28086f
Minor revisions similar to some information in the new docstrings.
2000-07-08 16:59:03 +00:00
c826ecbf8f
Add an entry for the KDE File Manager support from Peter Funk.
2000-07-07 17:08:40 +00:00
e4dbb86ab8
New module webbrowser. Easy-to-use controller objects to make using a
...
Web browser as a help/information browser easy across platforms.
2000-07-07 03:36:12 +00:00
aa7524cf1f
Clean up markup to be more like recommended practice; only small changes
...
needed.
2000-07-06 18:37:08 +00:00
29fa30ea6b
Correct a markup nit that caused a space to be dropped from the HTML
...
version (actually a LaTeX2HTML bug), and clarified a sentence in the
mktime() description based entirely on comments from Grant Griffin
<grant.griffin@honeywell.com>.
2000-07-06 18:09:02 +00:00
3c62d9e656
Several small changes, mostly to the markup, to improve consistency and
...
internal hyperlinking. Move some things around, also for consistency
with other modules ("See also" stuff tends to live at the \section level,
before sub-sections, etc.).
2000-07-06 04:51:04 +00:00
14ea85f325
Add entry for readline documentation.
2000-07-06 04:47:25 +00:00
011028cf74
Sjoerd Mullender <sjoerd@oratrix.nl>:
...
Updates for recent changes in xmllib.
2000-07-06 04:45:14 +00:00
d14423abe2
Correct typo in description of the machine name parameter to the
...
ConnectRegistry() function; there is no trailing period!
2000-07-06 04:38:37 +00:00
63099f911f
added seealso pointing reader at readline example which uses atexit.
2000-07-06 03:26:39 +00:00
510ca1d338
simple-minded readline section doc based upon module's doc strings.
2000-07-06 03:25:26 +00:00
0915165096
added warning about incompatibility with other codes' use of sys.exitfunc.
2000-07-05 23:11:26 +00:00
b5316188ee
Created a new chapter on structured markup processing, including the
...
existing SGML, HTML, & XML support, and providing a home for the new
XML support as it becomes documented.
2000-07-05 02:24:39 +00:00
c05cbb0527
Wrapped some long lines.
...
Cleaned up the table of error constants defined in pyexpat.errors; an
extra pair of braces had pretty much destroyed the table! (Not sure why.)
Moved the pyexpat.errors module documentation into a \section with the
proper headers for a module.
2000-07-05 02:03:34 +00:00
25e7cee1c8
get_starttag_text(): Document this method.
2000-07-03 14:32:04 +00:00
52dc76c81f
Eric S. Raymond <esr@thyrsus.com>:
...
This patch implements relative-path semantics for the "source" facility resembling
those of cpp(1), documents the change, and improves the shlex test main to
make it easier to test this feature. Along the way, it fixes a name error
in the existing docs.
[Additional documentation markup changes for consistency by FLD.]
2000-07-03 09:56:23 +00:00
353aaadd9b
Moshe Zadka <moshez@math.huji.ac.il>:
...
Substantial updates to reflect Moshe's Gordon's enhancements to the
module.
Additional changes from Fred to reflect his changes to the module as well.
2000-07-03 08:24:49 +00:00
fcc95a4d04
Tim-blessed documentation for math.frexp().
2000-07-03 06:38:17 +00:00
c3a65982a3
others --> other's (possessive)
...
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:47:38 +00:00
506a7a87ff
Send a "ARTICLE" --> Send an "ARTICLE"
...
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:43:19 +00:00
30f76ffd00
Update version numbering from 1.6 to 2.0.
2000-06-30 16:06:19 +00:00
f0e88980f3
Document randrange().
2000-06-30 15:32:31 +00:00
57a2f7f8ef
Change description of altzone to not refer to the "0th meridian".
2000-06-30 04:24:52 +00:00
9a748aa832
Say "manual page", not "man page", when referring to the Unix manual.
2000-06-30 04:21:41 +00:00
abbc7344a4
Make sure to note that this module was added for Python 2.0!
2000-06-30 03:50:06 +00:00
6e71cdd9f1
Reflect the name change to _winreg; we still need documentation for the
...
new winreg module.
2000-06-30 03:45:40 +00:00
efc43d4478
Document recently-added mouse-related functions
2000-06-30 01:05:39 +00:00
8aa3bd9098
Make it clear that id() can return either a long integer or a plain integer.
2000-06-29 03:46:46 +00:00
5c529d3f3e
Add a "See also:" link to the curses.ascii module.
2000-06-28 22:11:40 +00:00
589f44b9d0
Made the title of the Examples subsection plural!
2000-06-28 22:09:20 +00:00
be93a8332e
Added note that the atexit module was added for Python 1.6.
2000-06-28 22:07:55 +00:00
6f2a5efec9
Added entry for the curses.ascii module.
2000-06-28 22:05:44 +00:00
5ccd4b2a54
Added entries for the curses.ascii module.
2000-06-28 22:03:29 +00:00
4e716fa0ac
Skip Montanaro <skip@mojam.com>:
...
Added an example of using an HTTP POST request.
2000-06-28 21:51:43 +00:00
c82634c13c
Thomas Wouters <thomas@xs4all.net>:
...
Documentation updates related to the addition of openpty() and forkpty().
2000-06-28 17:27:48 +00:00
c19425d520
Added the atexit module and documentation from Skip Montanaro
...
<skip@mojam.com>. Revisions to the markup to make it pass LaTeX, added
an index entry and a reference from the sys.exitfunc documentation.
This closes SourceForge patch #100620 .
2000-06-28 15:07:31 +00:00
af5b76677f
Changed obsolete e-mail alias
2000-06-27 03:16:04 +00:00
f57d7b9e30
Dcoumentation for ascii.py. I've changed two references from ascii to
...
curses.ascii.
2000-06-26 23:59:24 +00:00
a4ca07cc8c
Minor grammatical fix
2000-06-21 01:48:46 +00:00
d24ff44f06
Document .timeout() method and .typeahead() function
2000-06-21 01:42:51 +00:00
0adfb45b9a
Make changes and clarifications suggested by Mark Hammond
2000-06-18 04:17:38 +00:00
b8050697b8
Documentation for the mmap module: proofreaders welcomed
2000-06-17 22:39:05 +00:00
9e759dfc31
Michael Hudson <mwh21@cam.ac.uk>:
...
This patch corrects a little glitch and two outright errors.
(Including one reported earlier by Thomas Wouters.)
2000-06-15 18:44:30 +00:00
fb79ffae4d
Hook in the documentation for the unicodedata module.
2000-06-13 20:51:29 +00:00
28b294459d
Marc-Andre Lemburg <mal@lemburg.com>:
...
Documentation for the unicodedata module (massaged by Fred for minor
consistency issues).
2000-06-13 20:50:50 +00:00
6b14eebae6
Documentation for the pyexpat module.
2000-06-11 02:42:07 +00:00
d1a65ff40b
Added preliminary documentation for the winreg module,
...
by Mark Hammond <markh@activestate.com>.
Limited markup & consistency revisions by FLD.
2000-06-07 04:07:48 +00:00
6c16019136
Fixed typo noted by Guido Kollerie <gkoller@cs.vu.nl> in example code.
2000-05-30 14:39:45 +00:00
b80a777859
Added documentation for gettempprefix().
...
Deprecated direct access to template.
Added note about past need to modify template so that legacy code has a
better chance of being understood, noting that the requirement to reset
template after os.fork() disappeared in 1.5.2.
2000-05-26 19:32:14 +00:00
0233075fce
Added documentation for TemporaryFile() and the siffix parameter to mktemp().
...
Removed obsolete comments about this module not creating or removing actual
files.
Removed obsolete comment about users needing to set template to None after
calling os.fork().
2000-05-26 19:05:16 +00:00
99d707af47
Piers Lauder <piers@cs.su.oz.au>:
...
I've added an extra comment about quoting arguments to
IMAP4 commands. Also changed the command descriptions
to show optional extra commands where appropriate.
Fred Drake:
Added example usage for the search() method based on comments from
<Lucas.DeJonge@awtpl.com.au>; elaborated error handling information
when arguments are missing from search() and uid().
2000-05-26 04:08:37 +00:00
f1dc5fa2c8
Updated docs to list all the new methods and functions. The docs are
...
now complete, but probably still not very helpful or friendly.
Note: two very large tables (of key names, and of character names) were
added; these tables format terribly, and need some reworking.
2000-05-23 16:46:04 +00:00
7cb42cd070
From Greg Ward <gward@python.net>:
...
Typo: "dictionairy" --> "dictionary" (twice).
2000-05-23 02:28:26 +00:00
8c5cedee69
New description for math.frexp() -- poor description noted by
...
Francois Pinard.
2000-05-18 05:07:38 +00:00
c9a5f343bc
The addition of rint() (by Peter Schneider-Kamp; I forgot to mention
...
that before) in the previous patch has one problem; rint() is not in
the C math library on all platforms (e.g. not for VC++). Make it
conditional on HAVE_RINT.
2000-05-11 18:42:27 +00:00
71260b846e
Added math.rint() -- round according to current IEEE754 mode
2000-05-11 18:19:42 +00:00
625d70a7a6
Fix references to the built-in compile() that don't include the
...
filename parameter. Noted by Randall Hopper <aa8vb@yahoo.com>.
2000-05-09 17:10:23 +00:00
35784dff6a
Skip Montanaro <skip@mojam.com>:
...
The intent is that this diff adds a link to the rfc822 module doc and
an index reference to this module under the rfc822 heading.
Fred, based on a suggestion from Grant Griffin <grant.griffin@honeywell.com>:
Added link to the MIME FAQ, so people can more easily get more
information about the subject of the module.
2000-05-09 16:23:23 +00:00
d85f05940e
read() method: clarify that strings are accepted and interpreted
...
reasonably.
readfp() method: added documentation.
2000-05-09 15:06:32 +00:00
3d69c0e440
Someone found the examples of poor practice on socket addresses!
...
Spotted by Greg Kochanski <gpk@bell-labs.com>.
2000-05-03 19:40:32 +00:00
ae08853fb0
Clarify status of connection of a new instance; it *is* connected if
...
you pass server information to the constructor. Error noted by Pedro
Diaz Jimenez <diazjimenez@ctv.es>.
2000-05-03 15:11:47 +00:00
e06d025e00
Use \versionchanged to indicate when the second parameter to utime()
...
was allowed to be None.
2000-05-02 17:29:35 +00:00
d67ddbbec1
Eric Raymond:
...
(1) Added and documented the capability for shlex to handle
lexical-level inclusion and a stack of input sources. Also, the input
stream member is now documented, and the constructor takes an optional
source-filename. The class provides facilities to generate error
messages that track file and line number.
(2) Add a convenience function to generate C-compiler style error
leaders.
2000-05-01 20:14:47 +00:00
93a8eacde5
Document the new additional signature for utime(). In addition to the
...
previous functionality utime(path, (atime, mtime)), now allowed is
utime(path, None) which sets the file's times to the current time.
2000-05-01 16:18:22 +00:00
40ee7acb95
\file and \filenq should not be used in section titles; they are not
...
sufficiently robust to survive the creation of bookmarks in the PDF
format.
2000-04-28 18:17:23 +00:00
ac308d0a6f
Added a "See also:" section that exhibits the \seerfc markup.
2000-04-26 18:20:04 +00:00
cebda6f5f0
Added documentation for WindowsError; omission noted by Michal Bozon
...
<bozon@natur.cuni.cz>.
(Mark Hammond, other Python/Windows cognoscenti: please check this!)
2000-04-17 17:42:00 +00:00
9cf7587fdc
Update change to version_info structure.
2000-04-13 17:51:58 +00:00
4d65d73686
Document hexversion (incompletely explained) and version_info (easily
...
explained).
2000-04-13 16:54:17 +00:00
ee775a194c
Make use of \longprogramopt where appropriate.
2000-04-11 19:46:40 +00:00
0682be4524
letters:
...
Fix description; lowercase and uppercase are strings, not
functions! Noted by Randall Hopper <aa8vb@yahoo.com>.
maketrans():
Minor markup nits in description.
2000-04-10 18:35:49 +00:00
9164f88657
Fix Skip's email address in his attribution! (Thanks, Skip!)
2000-04-08 04:53:29 +00:00
c2c46c3751
New example from Skip Montanaro <skip@mojam.com>.
2000-04-07 16:09:59 +00:00
69ca950d1f
Make sure the \declaremodule uses the right name for the module!
...
Clean up several markup problems & inconsistencies.
2000-04-06 16:09:59 +00:00
343301aaa4
unichr(),
...
unicode(): Added \versionadded{} annotations.
2000-04-06 15:06:03 +00:00
0b72116812
Marc-Andre Lemburg <mal@lemburg.com>:
...
Added UnicodeType.
2000-04-06 15:05:04 +00:00
56ced2a7e4
Marc-Andre Lemburg <mal@lemburg.com>:
...
Added note that Unicode strings are picklable.
2000-04-06 15:04:30 +00:00
5828ad6963
Revised / removed comments about string exceptions (relating to the
...
standard exceptions), added documentation of UnboundLocalError.
2000-04-06 15:03:01 +00:00
3cb793e8e8
Marc-Andre Lemburg <mal@lemburg.com>:
...
Added UnicodeError description.
2000-04-06 14:48:35 +00:00
61098f201e
Marc-Andre Lemburg <mal@lemburg.com>:
...
Add Unicode strings to the list of marshalable types.
2000-04-06 14:47:20 +00:00
665dd704a3
Note the exception raised when parameter to chr() is out of range.
2000-04-06 14:45:19 +00:00
33d51841a3
Marc-Andre Lemburg <mal@lemburg.com>:
...
Documentation for unichr(), unicode(), update for ord().
2000-04-06 14:43:12 +00:00
98f8a3d8da
Added codecs entry here as part of String Services.
2000-04-06 14:25:28 +00:00
b7979c756c
Marc-Andre Lemburg <mal@lemburg.com>:
...
codecs module documentation, with some preliminary markup
adjustments from FLD.
2000-04-06 14:21:58 +00:00
6d5c6bdb25
Removed bogus connect() call in SMTP example; reported by Travis
...
B. Hartwell <slt5v@cc.usu.edu>.
Removed second copy of the "See also" section!
2000-04-05 22:12:06 +00:00
71b04dab58
Added reference to the multifile module from the "See also" section
...
in the mimetools documentation.
Suggested by Skip Montanaro <skip@mojam.com>.
2000-04-05 22:05:15 +00:00
d1a56f4235
Noted by Guido:
...
Fixed up descriptions of altzone and timezone not to refer to the
0th meridian, which doesn't exist. Reference is now to UTC.
2000-04-05 15:06:03 +00:00
898915d7e2
Noted by Guido:
...
Directionality of up/down were confused.
2000-04-05 15:01:36 +00:00
43b89b637f
Noted by Guido:
...
Note in the "Caveats" section should refer to the exit() function, not
exit_thread().
2000-04-05 15:00:38 +00:00
12ed36525a
Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>
...
(re-written).
2000-04-04 20:43:50 +00:00
005f494a7f
Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>.
2000-04-04 20:42:38 +00:00
7d68690d8d
Added notes about the eventual disappearance of two-parameter bind(),
...
connect(), and connect_ex().
I didn't make these deprecation notices since it was never a
documented feature.
2000-04-04 17:48:30 +00:00
38e5d27cae
Merged changes from the 1.5.2p2 release.
...
(Very rough.)
2000-04-03 20:13:55 +00:00
6a0d844e76
UserString section:
...
Small cleanups noted by Detlef Lannert
<lannert@lannert.rz.uni-duesseldorf.de>.
Make the spelling of Unicode always uppercase.
2000-04-03 15:02:35 +00:00
a22b576d05
UserString class from Peter Funk <pf@artcom-gmbh.de>.
2000-04-03 03:51:50 +00:00
3c9f936eee
Two new sections. Preliminary.
2000-03-31 17:51:10 +00:00
15861b2a41
Update portability information for the spawn*() functions and related
...
constants. Someone will need to fill in information on the spawn*()
functions that aren't listed.
2000-02-29 05:19:38 +00:00
0baf773c44
Added entry for libtabnanny.tex.
2000-02-23 15:44:58 +00:00
155348be33
Initial version from Peter Funk <pf@artcom-gmbh.de>, with minor
...
consistency changes and a note that the API may change in the future.
2000-02-23 15:44:08 +00:00
1e862e8a37
Update the description of int() to include the radix parameter;
...
omission noted on c.l.py by Aahz Maruch.
Swapped the order of the descriptions of int() and intern() so that
int() comes first (the functions are in alphabetic order).
2000-02-17 17:45:52 +00:00
8006d316bc
Added docs for new crc32() function. By Jim Ahlstrom.
...
(Fred, please check.)
2000-02-16 21:13:37 +00:00
41d84631ba
Document the API changes to the nntplib module (exceptions become
...
classes, NNTP.__init__() grows a new optional argument to set reader
mode on the server).
2000-02-10 20:26:45 +00:00
2bb43a20ce
The dircmp module is now obsolete.
2000-02-03 15:27:26 +00:00
76e6da38c0
Document GetoptError and label error an alias.
1999-12-21 22:50:05 +00:00
b9bdfc6a23
Document 1.5.2+ aspects of the NotANumber exception. (Note that this
...
is in the development branch, not the maintenance branch!)
1999-12-21 18:45:16 +00:00
89ab163479
Document that the |mode| parameter to open() is optional and explain how
...
the default value is determined.
1999-12-21 18:31:30 +00:00
88f6ca2ce9
Document getgroups(), getlogin(), fpathconf(), pathconf(),
...
pathconf_names, confstr(), confstr_names, sysconf(), sysconf_names.
1999-12-15 19:39:04 +00:00
d16b5abc07
Markup consistency nits that Guido didn't check. ;-)
1999-12-13 23:34:42 +00:00
5f7a28cdf8
Doc update from Piers Lauder see changes for imaplib.py version 2.16.
1999-12-13 23:29:39 +00:00
18f7a45324
Document the new stuff in the os module.
1999-12-09 22:11:43 +00:00
d4d4ba3fd2
Update link to PythonWare library page.
1999-12-01 18:44:09 +00:00
7424242c1c
Removed last XXX comment; no further action needed on this one.
1999-11-17 16:09:57 +00:00
55e93964e6
Preliminary documentation for turtle module (Tk), by Moshe Zadka.
...
Fixed up a few TeXisms and markup nits, but otherwise unchanged.
Somewhat raw.
1999-11-15 17:03:41 +00:00
37f1574f2e
Use \citetitle and \programopt as appropriate.
1999-11-10 16:21:37 +00:00
ebe0341109
Use \citetitle instead of \emph.
1999-11-09 20:11:17 +00:00
356d0ceb7e
Use \citetitle in one place.
1999-11-09 20:10:01 +00:00
268df27c9a
Use the new markup as apporpriate.
1999-11-09 19:45:59 +00:00
6e9ea59a43
Use \programopt in one place.
1999-11-09 19:44:44 +00:00
d290c10890
Use \programopt in one place.
1999-11-09 18:03:00 +00:00
6cf186b867
pathes --> paths; typo reported by Gerry Wiener <gerry@ucar.edu>.
1999-10-29 17:51:29 +00:00
47a27b6640
Make references to new filecmp module hyperlinks now that there's
...
documentation.
1999-10-29 17:25:59 +00:00
adf2dbfced
Added section for filecmp.
1999-10-29 17:24:12 +00:00
c7b5b3c998
filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
1999-10-29 17:23:15 +00:00
7eaf6828cb
Added deprecation notes, in case anyone decides to read these anyway.
1999-10-26 16:31:51 +00:00
143db4b041
cmp and cmpcache are now obsolete, so don't include their
...
documentation sections.
1999-10-26 16:28:04 +00:00
a8052a3113
Added cmp and cmpcache to the "Obsolete" section.
1999-10-26 16:27:28 +00:00
714fd26a2f
Documented Beep() function.
1999-10-22 21:08:56 +00:00
39d4a0237a
Fixed typo in explanation of abspath(); noticed by Paul Prescod
...
<paul@prescod.net>.
1999-10-18 14:10:06 +00:00
933d5a7c6e
os.name: Note that 'java' is one of the registered names.
1999-09-17 14:38:39 +00:00
e6fb1c4bd3
Added documentation for inet_aton() and inet_ntoa(), from Ben
...
Gertzfield <che@debian.org> (with minor changes).
(Should have been here instead of in the branch in the first place,
since these weren't in for the 1.5.2 release.)
1999-09-16 15:50:00 +00:00
244ad3ca15
Name the parameter to expr() and suite() "source" instead of "string".
1999-09-09 14:16:36 +00:00
e7f19200e8
Doco update from Sjoerd Mullender.
1999-08-26 15:57:44 +00:00
b68a125d64
Added additional index entries.
...
Minor markup nits.
1999-08-24 20:16:29 +00:00
76dd228f52
whrandom should come immediately after random, not before.
1999-08-23 20:12:11 +00:00
7eba1d8bbe
Tell what the result objects are (based on comment from the list).
1999-08-19 17:00:38 +00:00
b3fc9d148d
Added disclaimer to the sleep() function.
1999-08-19 14:42:54 +00:00
31e5e37196
Explain the possible range of values for the pid parameter to
...
waitpid().
1999-08-13 13:36:33 +00:00
68921dfa31
In note mentioning [].remove()'s exception, tell what exception is
...
raised. Prompted by Barry's whining. ;-0
1999-08-09 17:05:12 +00:00
d3fbdfd007
Add index entries for open():
...
buffer size, I/O
I/O control, buffering
line-buffered I/O
unbuffered I/O
1999-08-05 13:43:08 +00:00
8c9fc00f8d
Add index entry "I/O control, buffering" for fdopen().
1999-08-05 13:41:31 +00:00
a94f6762bc
Add index entry "I/O control, buffering" for makefile().
1999-08-05 13:41:04 +00:00
068bdb181d
Change the directory tree walking example to use clearer variable
...
names, some suggested by Joe Ellsworth.
1999-08-03 21:52:29 +00:00
c71b802c47
Markup nits.
...
Adjust examples to use the object interface instead of the function
interface.
1999-08-02 14:30:52 +00:00
ce201128b0
Fixed hyperlink references to the __builtin__ and __main__ modules;
...
error reported by Dale Nagata <DNagata@creo.com>.
1999-08-02 14:13:09 +00:00
8d21243c3e
Added description of optional parameter to UserDict constructor.
...
Omission reported by Barry Warsaw.
1999-07-26 15:45:52 +00:00
de5d5ce7bc
Update getattr() description to document the optional third
...
parameter. Thanks to Barry Warsaw for pointing out the oversight.
1999-07-22 19:21:45 +00:00
5d48e458e4
typo: privide --> provide
...
Reported by Nadim Ghaznavi <nadim@ghaznavi.com>.
1999-07-20 13:21:42 +00:00
6db897c52c
Move chdir() and getcwd() descriptions to "Files and Directories" with
...
a pointer from the "Process Parameters" section. Based on comments
from Aahz Maruch, Tim Peters, and GvR.
1999-07-12 16:49:30 +00:00
3a4ceb707d
Several methods return tuples, not lists.
1999-07-07 14:04:38 +00:00
363d67c2e6
Move some misc. comments from the example section to the main section.
...
Use the lowercase versions of the method names in the example, since
that's what's documented (Greg Stein's suggestion). Add a blank line
after the import line for clarity.
1999-07-07 13:42:56 +00:00
1508970a47
dir() method description revised based on comments from Greg Stein.
1999-07-07 13:36:22 +00:00
6166b871a2
Missing space; reported by Robert Kern <kernr@ncifcrf.gov>.
1999-07-06 21:00:18 +00:00
d5dfe984e7
Fix a number of minor problems pointed out by /F.
1999-07-06 15:50:23 +00:00
0d6e6e0b39
Fixed typo reported by /F; thanks!
1999-07-06 15:43:55 +00:00
82ac24ffb0
Minor markup nit.
1999-07-02 14:29:14 +00:00
0452007dcc
Added entry for asyncore module.
1999-07-02 14:27:03 +00:00
41796918af
Fix a few markup nits, improve some index entries.
1999-07-02 14:25:37 +00:00
7d80779532
New documentation from Chris Petrilli <petrilli@amber.org>.
1999-07-02 14:25:03 +00:00
227020894a
For spawn*(), point to the magic constants; some readers have a hard
...
time finding the bindings.
1999-07-02 14:01:03 +00:00
e4694eba0f
Removed entries for several modules which have been documented.
...
Updated comments on several remaining modules.
1999-07-01 20:42:57 +00:00
4c8d83f311
Documentation for dl module from Moshe.
1999-07-01 20:40:21 +00:00
44a7a7c5d0
Added entry for dl module.
1999-07-01 20:39:59 +00:00
85b5683307
Remove extraneous "contains" -- pointed out by Daniel Barclay
...
<danielb@digitalfocus.com>.
Added credit to Martin von Loewis for creating the module and
documentation.
1999-07-01 16:31:03 +00:00
859dc53a52
Per Frank Stajano's suggestion, state explicitly that the functions
...
described in the sub-sections are directly available at the module
level. He found this confusing.
1999-07-01 13:54:40 +00:00
b216060627
Make the reference to the os module in the module synopsis (for the
...
table at the front of the chapter) a hyperlink.
1999-07-01 13:53:32 +00:00
3d0971e33e
For "Matching vs. Searching", remove comment that the section is
...
incomplete; I don't remember what else I thought I was going to put
in, but it looks o.k. to me know.
1999-06-29 21:21:19 +00:00
6bf37debb9
Added some minor prose before the descriptions of the data attributes
...
to make it clear that these are instance attributes, not module data.
1999-06-29 18:13:37 +00:00
abc64b74c8
Added entry for pty module.
1999-06-29 18:12:22 +00:00
a4b5d58790
pty documentation from Moshe; with small edits.
1999-06-29 18:11:22 +00:00
31d10cbe26
Improve description of the example.
1999-06-29 17:08:41 +00:00
f5213c2a3d
Usage nit: a bunch of "nor"s should have been a single "or".
...
Make reference to the copy_reg module a hyperlink.
1999-06-29 16:02:12 +00:00
8ad2703bfb
Minor wording change in section title.
1999-06-29 16:00:22 +00:00
ac00c4c1c6
byteswap() method: Tell *what* exception gets raised when the type
...
cannot be byteswapped.
1999-06-29 15:58:00 +00:00
9118f7cfc4
Remove unnecessary comma.
1999-06-29 15:53:52 +00:00
9e0b6229f6
Comment out XXX comment; this needn't appear in the formatted
...
versions. XXX comments only need to be grep-able.
1999-06-29 15:45:09 +00:00
ef1a029d4c
Add note about not being able to use this module with modules not
...
implemented in Python.
1999-06-29 15:43:02 +00:00
4886c66daf
Moshe: Remove extraneous "and".
1999-06-29 14:57:12 +00:00
e4d78189e8
Added entries for mutex and nis modules.
1999-06-27 15:02:37 +00:00
7fefba5c13
NIS documentation from Moshe.
1999-06-27 15:01:08 +00:00
2231357aa6
Mutex documentation from Moshe.
1999-06-27 15:00:41 +00:00
7a65a26f81
Separate documentation of SUNAUDIODEV from sunaudiodev; this mirrors
...
similar constructs elsewhere (al/AL, gl/GL/DEVICE).
1999-06-27 14:53:11 +00:00
14ae4b48fb
Fix some typos.
...
Add an index entry.
1999-06-25 19:13:36 +00:00
c4e3bf9b5e
Add entries for the sched module.
1999-06-25 18:54:30 +00:00
7e990323b4
Moshe's section on the sched module, with edits.
1999-06-25 18:52:44 +00:00
60b66e1f7b
Update to Sjoerd's documentation of the chunk module, with some
...
additions from Moshe's version. Used my table for describing the
chunk format, and added some markup and index entries.
1999-06-25 17:52:17 +00:00
cf6905f986
Clarify the example by explicitly importing the fcntl module -- this
...
avoid being fooled into thinking that fcntl and FCNTL are the same
thing -- they aren't! (fcntl is the extension, FCNTL.py is h2py
output that defines all the constants).
(XXX The example is still weird -- I think there's a more portable way
to do locking now. That's for someone else to fix...)
1999-06-24 17:58:44 +00:00
7c2426439e
Removed tty module entry.
1999-06-23 17:31:59 +00:00
1b2dc9045e
Add entries for tty module.
1999-06-23 17:29:02 +00:00
0bccd73be0
Updates from Moshe, again edited by me. Describe the parameters to
...
border() using a table instead of text for ease of comprehension.
1999-06-23 17:28:01 +00:00
92f3f41424
Added "See Also" section for termios module.
1999-06-23 15:12:09 +00:00
ae4d5c23f5
Various updates.
1999-06-23 14:56:13 +00:00
66239d5530
tty module documentation from Moshe, with some editing and an added
...
"See also" section.
1999-06-23 14:30:19 +00:00
af81a509c3
Added more sections...
1999-06-23 13:34:22 +00:00
b742a42bc0
Two more from Moshe!
1999-06-23 13:33:40 +00:00
707f8e67b9
Added entry for the chunk module.
1999-06-22 18:50:06 +00:00
97793ab6b9
New section from Moshe Zadka, modified by FLD for markup, some
...
additional content.
1999-06-22 18:49:20 +00:00
0f871dc39e
Added some "See also" references to htmllib docs.
...
Documented htmlentitydefs.
1999-06-21 21:20:56 +00:00
2cd31dc3ea
Added entry for curses module.
1999-06-21 21:14:30 +00:00
a4070cef5e
Preliminary documentation for the curses module by Moshe Zadka, with
...
lots of markup fixes and some English nits fixed.
Still needs real review. Some of the function signatures used in this
module are really bad! (Two leading optional parameters? Ugh!)
1999-06-21 21:13:09 +00:00
d5d55ea02e
Fix a markup error.
1999-06-21 18:36:09 +00:00
4755e7d5c1
Three more modules documented by Moshe!
1999-06-21 18:25:49 +00:00
6f49e0a154
Added a few minor comments, mostly to discourage documentation of
...
really old modules that may become obsolete.
1999-06-18 19:58:59 +00:00
a88ef00a50
Further clarfication of the system-dependence of the system() return
...
value, based on comments from Tim Peters.
1999-06-18 19:11:25 +00:00
46e1a32edf
Re-categorize the dump module as obsolete.
1999-06-18 17:12:15 +00:00
354e98222c
fpformat has been documented for at least a week now!
1999-06-18 15:21:25 +00:00
26921da2c9
Small markup & usage adjustments.
1999-06-17 18:58:02 +00:00
e019789962
Correction: the parameters of new.instance() are type-checked.
...
Edited several of the descriptions for English usage and more
consistent style.
1999-06-17 18:15:07 +00:00
Fred Drake
Barry Warsaw
Jeremy Hylton
Sjoerd Mullender
Skip Montanaro
Moshe Zadka
Andrew M. Kuchling
Thomas Wouters
Guido van Rossum
Peter Schneider-Kamp
Eric S. Raymond
Vladimir Marangozov
Mark Hammond