7a6b4f0284
more markup chages
2003-07-17 16:00:01 +00:00
8836e567b9
- remove mention of the isprivate flag, since that isn't directly
...
documented here, and according to Tim, should never have been there
- misc. cleanups for consistency
2003-07-17 15:22:47 +00:00
943277ecd3
Minor corrections.
2003-07-17 14:47:12 +00:00
38d7c1bb78
Note that Unicode strings are now supported in sys.path.
...
SF patch #764594 .
2003-07-17 04:22:44 +00:00
bfa6872260
Zap the C API subsection altogether for now. It's not actually usable from
...
C yet anyway.
2003-07-16 21:14:35 +00:00
2491cd98c4
expose the C API subsection which was hidden from LaTeX in a comment. In
...
the info conversion the \comment LaTeX macro mapped to a Texinfo @ignore
macro. Unfortunately, py2texi.el is not smart enough to avoid generating
links to the @ignore'd section, which causes makeinfo to croak.
Exposing this text is probably not the most correct thing to do, as this
documentation really belongs in the C API manual. This does get the info
files generated, however, which is a more practical goal considering the
impending release of 2.3rc1.
2003-07-16 19:46:07 +00:00
71adf7e9d8
Doctest now examines all docstrings by default. Previously, it would
...
skip over functions with private names (as indicated by the underscore
naming convention). The old default created too much of a risk that
user tests were being skipped inadvertently. Note, this change could
break code in the unlikely case that someone had intentionally put
failing tests in the docstrings of private functions. The breakage
is easily fixable by specifying the old behavior when calling testmod()
or Tester(). The more likely case is that the silent failure was
unintended and that the user needed to be informed so the test could be
fixed.
2003-07-16 19:25:22 +00:00
853276e16d
Lots of markup cleanups to avoid warnings from the GNU info generation;
...
these make sense even without that processing chain.
2003-07-16 17:58:38 +00:00
788617f8f0
Remove \versionchanged; the text was too complex for the GNU info
...
conversion to support. Keep the content as normal content, with a
note that this applies starting in Python 2.3.
2003-07-16 16:19:08 +00:00
d24c767d5b
A variety of markup-level adjustments.
2003-07-16 05:17:23 +00:00
46f681cc07
Discussion of signatures for unicode.translate() and str.translate()
...
were in the wrong file. Moved out of libstring.tex and into
libstdtypes.tex.
2003-07-16 05:11:27 +00:00
d9cf8e7e7c
Markup consistency nits.
2003-07-14 21:07:05 +00:00
9753ae1237
Added missing markup.
2003-07-14 20:53:57 +00:00
708c2a877e
Fix unbalanced parenthesis in text.
2003-07-14 18:36:47 +00:00
0e53d234eb
Fix missing parenthesis
2003-07-14 18:24:26 +00:00
7233117960
update norobots link
2003-07-14 17:04:50 +00:00
a2d3d93ee3
+ libdumdbm
2003-07-14 12:13:27 +00:00
d54c5ddd28
minimal dumdbm module doc
2003-07-14 12:12:37 +00:00
9bb33868af
SF bug #738090 : Section 13.3: htmllib.HTMLParser constructor definition
...
amendment
Add a clarifying cross-reference to the formatter module.
2003-07-14 08:15:47 +00:00
5c5fca9844
SF bug #706546 : u''.translate not documented
...
Clarified the difference between translate methods for string objects and
Unicode objects.
2003-07-13 02:06:47 +00:00
627273733f
SF bug #770107 : Typo in documentation of resource module
2003-07-13 00:46:40 +00:00
162f081fb3
Patch 549151, rev4: redirect posts for 301 also. Will backport to 2.2.
2003-07-12 07:33:32 +00:00
92f21b13ea
Document Jim Fulton's docttest extensions.
2003-07-11 22:32:18 +00:00
9de3c21865
SF #767592 : unittest docs don't suggest "unittest.main()"
...
Expanded docs to have a quick start example showing how
to create and run tests.
2003-07-10 22:14:41 +00:00
a4d2b869b9
Add versionadded. Remove duplicate "to"
2003-07-09 12:41:55 +00:00
0b1782f7c0
Document interrupt_main()
...
Remove obsolete reference to deprecated exit_thread() function
2003-07-08 17:07:20 +00:00
dd3afa75b3
add missing '
2003-07-08 16:26:34 +00:00
9a5b6a6f08
- clean up table markup for readability
...
- don't use \constant for literals; it's for "defined" constants
- fix various consistency issues
2003-07-08 15:38:40 +00:00
8120995b56
Update Tkinter3000 notes based on text from Fredrik Lundh.
2003-07-08 13:44:27 +00:00
a6b7d3411f
Fixed a table that wasn't in a tableii block, and added a very simple
...
example to show how to log to a file.
2003-07-08 08:40:20 +00:00
7cb229df18
add versionadded for getcheckinterval
2003-07-07 14:11:53 +00:00
e5e065b669
New function sys.getcheckinterval(), to complement setcheckinterval().
2003-07-06 18:36:54 +00:00
b25229d823
Fix SF bug #766288 , property() example gives syntax error
2003-07-05 17:37:58 +00:00
eec26f982a
Correct documentation of check interval - it's 100 by default, not 10 any
...
longer. Pointed out by Alex Martelli.
2003-07-02 21:38:34 +00:00
5e4e39f12a
Note that csv files (when they are actual files) must be opened in 'b'inary
...
mode. Note that the only restriction on the csvfile passed to writer
objects is that it have a write method.
2003-07-02 15:32:48 +00:00
774816f817
SF bug #764616 : execfile(filename,...) not execfile(file,...)
...
Clarify parameter name.
2003-07-02 15:31:54 +00:00
f8020e0211
Grammar nit. SF bug #757822
2003-07-02 15:10:38 +00:00
c5528b1f5c
Revert the previous change; this is now dealt with in a better way.
2003-07-02 14:44:55 +00:00
1ec0bdf899
The datetime C API really isn't usable outside the datetime module
...
implementation, so remove this decoy (it break formatting of the GNU
info version of the docs).
2003-07-02 13:42:51 +00:00
2884d6de15
Fix a variety of small markup nits.
2003-07-02 12:27:43 +00:00
3ede7848a9
- note that super() only applies to new-style classes;
...
closes SF bug #764003
- fix markup for consistency
2003-07-01 16:31:26 +00:00
93ceaea01f
showwarning() calls formatwarning(), not showwarning().
...
Bugfix candidate.
2003-07-01 14:37:59 +00:00
9c8f78deab
Improve the wording a bit
2003-07-01 07:19:17 +00:00
69d6356eb9
Fix spelling, grammar, usage, and markup.
2003-07-01 06:29:18 +00:00
20def8bb19
Make temporary change of using _strptime for time.strptime permanent.
...
Flesh out docs to better explain time.strptime (closes bug #697990 ).
2003-07-01 05:16:08 +00:00
ecc7171007
Add versionadded info for the 2 new threading module functions
2003-06-30 21:47:47 +00:00
5728815e7b
Fix broken markup, & tweak a couple of things for consistency.
2003-06-29 18:12:23 +00:00
bfccb35b58
Add settrace() and setprofile() functions to the threading library.
2003-06-29 16:58:41 +00:00
be2528d866
SF patch #760257 : add socket.timeout exception
...
(Contributed by Bob Halley)
Add documentation for the new socket.timeout exception.
2003-06-29 04:55:59 +00:00
3567a876c7
Add take() to examples. Tighten the islice() example
2003-06-28 05:44:36 +00:00
5d2f515dd4
fix markup nits
2003-06-28 03:09:06 +00:00
6f3eaa67e5
SF patch #761519 : Fixes for bugs 760703 and 757821
...
SF bug #760703 : SocketHandler and LogRecord don't work well together
SF bug #757821 : logging module docs
Applied Vinay Sajip's patch with a few minor fixups and a NEWS item.
Patched __init__.py - added new function
makeLogRecord (for bug report 760703).
Patched handlers.py - updated some docstrings and
deleted some old commented-out code.
Patched test_logging.py to make use of makeLogRecord.
Patched liblogging.tex to fill documentation gaps (both
760703 and bug 757821).
2003-06-27 21:43:39 +00:00
6ebe61fa80
A hack to ease compatibility with pre-2.3 Pythons: by default, doctest
...
now accepts "True" when a test expects "1", and similarly for "False"
versus "0". This is un-doctest-like, but on balance makes it much
more pleasant to write doctests that pass under 2.2 and 2.3. I expect
it to go away again, when 2.2 is forgotten. In the meantime, there's
a new doctest module constant that can be passed to a new optional
argument, if you want to turn this behavior off.
Note that this substitution is very simple-minded: the expected and
actual outputs have to consist of single tokens. No attempt is made,
e.g., to accept [True, False] when a test expects [1, 0]. This is a
simple hack for simple tests, and I intend to keep it that way.
2003-06-27 20:48:05 +00:00
f91888bb46
markup consistency nits
2003-06-26 03:11:57 +00:00
2b9bc08ee7
Removed useless intra-section references which jump to the top of the
...
section instead of the specific item being referenced.
2003-06-25 20:36:20 +00:00
2dd8c42638
SF bug #696777 : How to make a class iterable using a member generator.
...
* Added a note that a container class can implement the iterator protocol
by defining its __iter__() method as a generator.
2003-06-25 19:03:22 +00:00
35fd926195
SF bug #757822 : Additional index items, other minor details
...
* Minor grammatical fix.
2003-06-25 15:07:45 +00:00
9e9a7c3dd7
Patch #640236 : Better eplain unused data.
2003-06-21 14:15:25 +00:00
47db252786
Add some documentation which describes how to use the email package
...
instead of rfc822 as the Message factory.
2003-06-20 22:04:03 +00:00
3a03de4a27
SF #757229 , fix libsocket.tex typo
2003-06-20 17:11:39 +00:00
f5ed9819b0
Avoid using 'dir' as a variable name and use os.path.join() to create
...
paths.
2003-06-19 18:10:37 +00:00
befa37dd05
Minor updates:
...
* Updated comment on design of imap()
* Added untraversed object in izip() structure
* Replaced the pairwise() example with a more general window() example
2003-06-18 19:25:37 +00:00
b5155e30ce
Fix typo.
2003-06-18 01:58:31 +00:00
93719b56ed
Updated documentation for the new slice arguments for list.index().
2003-06-17 16:19:56 +00:00
364ca40c2a
SF Patch 569574 - enhancements to cgitb for plain text display
2003-06-17 12:58:31 +00:00
938b7a0f63
Fix some markup nits
2003-06-17 02:37:06 +00:00
9ca3f02dc0
^D means EOF on Unix but not on Windows. Expand the example's prompt to
...
tell Windows Truth too.
Bugfix candidate.
2003-06-15 23:08:45 +00:00
7e902b27e0
* Added missing documentation for object().
...
* Noted the Py2.3 in the optional arg for bool().
2003-06-11 09:15:26 +00:00
3985df2c99
SF bug #660022 : parameters for int(), str(), etc.
...
* Indicate that arguments are optional for most builtin type constructors.
* Replace e.g. in staticmethod() and classmethod() docs.
* Add \code{} markup to some in-line code examples.
2003-06-11 08:16:06 +00:00
132fa373d1
Add docs for get_grouped_opcodes().
2003-06-11 07:50:44 +00:00
80b3f685b4
SF bug: 751941 Invisible HTML tag
...
Added missing jump target labels.
2003-06-10 21:41:22 +00:00
9caa0d1642
guess_all_extensions(): Return the empty list instead of None when
...
there are no matching types. Updated the docs and docstrings. Added
some unit tests.
2003-06-09 22:27:41 +00:00
e07b83591f
Document context_diff() and unified_diff()
2003-06-09 21:44:59 +00:00
305908cffd
SF #735051 , add time.tzset documentation
2003-06-08 13:57:19 +00:00
9556fba685
- urllib2.py now knows how to order proxy classes, so the user doesn't
...
have to insert it in front of other classes, nor do dirty tricks like
inserting a "dummy" HTTPHandler after a ProxyHandler when building an
opener with proxy support.
2003-06-07 17:53:08 +00:00
a1045567e0
QUOTE_ALWAYS -> QUOTE_ALL
2003-06-04 15:30:13 +00:00
19a5a710fc
Patch #744238 : Explain that different string types also may compare equal.
2003-05-31 08:05:49 +00:00
7472336444
Patch #744877 : Explain filter in terms of list comprehension. Remove
...
explanation of int in terms of string.atoi. Explain sum in terms of
reduce.
2003-05-31 08:02:38 +00:00
847207acff
SF bug #719367 , string exceptions are deprecated
...
Remove references to string based exceptions in the doc.
2003-05-29 02:17:23 +00:00
d3d5768e5e
isdatadescriptor() was added recently.
2003-05-29 02:10:31 +00:00
fb1b5a164d
Rewrite the description of setparameters() so it actually reflects the
...
code (which has also been recently overhauled, so that it can be
documented without embarassment).
'error' has been renamed to 'OSSAudioError'.
Minor wordsmithing.
2003-05-29 01:39:32 +00:00
dad58601a0
Remove the note about the BerkeleyDB license. Barry indicates that
...
sleepycat has told him that since python is OSS and berkeleydb is
being distributed with python for the bsddb library all is fine.
2003-05-28 16:20:03 +00:00
c428112d29
Rename lib__future__.tex to libfuture.tex and add link in lib.tex.
2003-05-28 11:57:52 +00:00
5772513f0f
Include a link to the pybsddb web documentation for the modern object
...
oriented DbEnv & Db object BerkeleyDB interface.
Include a note about Sleepycat's BerkeleyDB license with regards to
distributing it within non-opensource applications and include a link
to their website for license details.
Document that 'r' is the default flag for the legacy bsddb btopen(),
hashopen(), and rnopen() functions. This is apparently different than the
dbm libraries in other languages according to Bug #732951 . Changing
the default from 'r' to 'c' would break backwards compatibility with
legacy bsddb applications; documenting the default should suffice.
2003-05-28 07:56:45 +00:00
451a766953
More wordsmithing and cleanup.
2003-05-26 01:51:33 +00:00
c316d0d391
Lots of wordsmithing and typographical improvement.
2003-05-23 02:44:46 +00:00
e41195fab6
Add documentation for __future__
2003-05-21 21:45:01 +00:00
15eac1f95c
Fix markup nits.
2003-05-20 16:21:51 +00:00
dbaf04ead6
Straighten out the docs for os.system(); the Unix and Windows behaviors
...
really can't be smushed together.
Bugfix candidate.
2003-05-20 16:15:58 +00:00
e5a55519a8
Remove unused line numbers from example code.
...
Line numbering of examples is not used elsewhere.
2003-05-20 15:21:08 +00:00
235d1efe12
Add docs for key_file and cert_file arguments for HTTPSConnection. Copied from socket.ssl docs.
2003-05-20 02:56:35 +00:00
7789237331
* Correct Sniffer doc to correspond to the implementation.
...
* Add optional delimiters arg to Sniffer.sniff() which restricts the set of
candidate field delimiters.
2003-05-19 15:33:36 +00:00
9e46abed50
Fix array.array.insert(), so that it treats negative indices as
...
being relative to the end of the array, just like list.insert() does.
This closes SF bug #739313 .
2003-05-18 03:15:10 +00:00
8f512a22cd
Add docs for MessageBeep.
2003-05-16 01:42:22 +00:00
7696344182
[Bug #471893 ] Replace security material with a warning against unpickling
...
untrusted data.
2003-05-14 16:51:46 +00:00
126d366ea6
document Stats.dump_stats(), new for Python 2.3
2003-05-14 14:29:27 +00:00
bf1bef820c
Add optional 'onerror' argument to os.walk(), to control error
...
handling.
2003-05-13 18:01:19 +00:00
c85bf58276
[Bug #732124 ] Clarify .pos, .endpos by saying 'method' instead of 'function'
...
Also, put match() description before search(); search() refers to match()
2003-05-13 14:40:24 +00:00
eabd9a1314
[Bug #729817 ] Document the rexec and Bastion modules as dead
2003-05-13 14:16:18 +00:00
032bd0a9a8
Fix typo
2003-05-13 14:13:58 +00:00
Fred Drake
Raymond Hettinger
Skip Montanaro
Martin v. Löwis
Neal Norwitz
Kurt B. Kaiser
Anthony Baxter
Tim Peters
Brett Cannon
Jeremy Hylton
Barry Warsaw
Walter Dörwald
Gustavo Niemeyer
Greg Ward
Gregory P. Smith
Guido van Rossum
Andrew M. Kuchling