Raymond Hettinger
c43a7e7c37
SF bug #827902 : ctime is not creation time
...
New fix for this bug recognizes differing definitions on various systems.
2003-10-29 00:46:19 +00:00
Armin Rigo
3be6d5d320
Documented gc.get_referrers() as dangerous.
...
SF bug 793822
2003-10-28 12:10:38 +00:00
Raymond Hettinger
8476c4df92
SF bug #827902 : ctime is not creation time
...
Document the correct definition of os.path.getctime()
2003-10-27 20:00:36 +00:00
Andrew M. Kuchling
b546be2448
Fix inaccuracy: all entities from XHTML 1.0 are supported (according to text further down in this file)
2003-10-27 15:46:16 +00:00
Raymond Hettinger
d591f666de
Replace the window() example with pairwise() which demonstrates tee().
2003-10-26 15:34:50 +00:00
Raymond Hettinger
6a5b027742
Added itertools.tee()
...
It works like the pure python verion except:
* it stops storing data after of the iterators gets deallocated
* the data queue is implemented with two stacks instead of one dictionary.
2003-10-24 08:45:23 +00:00
Andrew M. Kuchling
38afcef3f5
[Bug #809174 ] loads() and dumps() not documented
2003-10-22 14:12:03 +00:00
Fred Drake
d22bb6584d
Avoid confusing name for the 3rd argument to str.replace().
...
This closes SF bug #827260 .
2003-10-22 02:56:40 +00:00
Fred Drake
4e21dc9efd
- make this section format
...
- start cleaning up the markup for consistency
- comment out the reference to a MS KnowledgeBase article that doesn't
seem to be present at msdn.microsoft.com; hopefully someone can
point out an alternate source for the relevant information
2003-10-21 17:58:55 +00:00
Fred Drake
5b6150e066
markup fixes; this would not format
2003-10-21 17:04:21 +00:00
Fred Drake
86c60ed198
ConfigParser.items() and SafeConfigParser.items() no longer return a
...
generator. See SF bug #818861 .
2003-10-21 16:50:55 +00:00
Guido van Rossum
0c9a318d64
Use 'predicate = bool' as the default predicate for ifilter[false].
2003-10-20 17:01:07 +00:00
Walter Dörwald
f0dfc7ac5c
Fix a bunch of typos in documentation, docstrings and comments.
...
(From SF patch #810751 )
2003-10-20 14:01:56 +00:00
Gustavo Niemeyer
d969775d9c
Fixed \versionadded for the (?(id/name)yes|no) expression support.
2003-10-18 15:28:22 +00:00
Martin v. Löwis
6828e18a6a
Patch #825679 : Clarify semantics of .isfoo on empty strings.
...
Backported to 2.3.
2003-10-18 09:55:08 +00:00
Martin v. Löwis
849a972f35
Patch #809535 : Mention behaviour of seek on text files. Backported to 2.3.
2003-10-18 09:38:01 +00:00
Gustavo Niemeyer
ad3fc44ccb
Implemented non-recursive SRE matching.
2003-10-17 22:13:16 +00:00
Raymond Hettinger
42b1ba31af
* list.sort() now supports three keyword arguments: cmp, key, and reverse.
...
key provides C support for the decorate-sort-undecorate pattern.
reverse provide a stable sort of the list with the comparisions reversed.
* Amended the docs to guarantee sort stability.
2003-10-16 03:41:09 +00:00
Brett Cannon
4fc3855fb2
Initial checkin of docs for Lib/platform.py .
...
Closes patch #785752 and bug #726911 .
Should be backported after correctness and such has been verified by Fred.
2003-10-14 21:45:59 +00:00
Raymond Hettinger
c2a2832bee
SF bug #821701 : reduce docs neglect a very important piece of information.
...
Add a note showing which argument is the accumulator.
2003-10-13 17:52:35 +00:00
Raymond Hettinger
aac6ae9f26
SF patch #819955 : Erroneous \seemodule in tarfile docs
...
(Contributed by Johannes Gijsbers.)
2003-10-12 02:02:16 +00:00
Raymond Hettinger
dbe3d280e7
Adopt Christian Stork's suggested argument order for the logic quantifiers.
...
Adopt Jeremy Fincher's suggested function name, "any", instead of "some".
2003-10-05 16:47:36 +00:00
Raymond Hettinger
2f726e9093
SF bug #812202 : randint is always even
...
* Added C coded getrandbits(k) method that runs in linear time.
* Call the new method from randrange() for ranges >= 2**53.
* Adds a warning for generators not defining getrandbits() whenever they
have a call to randrange() with too large of a population.
2003-10-05 09:09:15 +00:00
Skip Montanaro
dffeed3ffa
Make the fieldnames argument optional in the DictReader. If self.fieldnames
...
is None, the next row read is used as the fieldnames. In the common case,
this means the programmer doesn't need to know the fieldnames ahead of time.
The first row of the file will be used. In the uncommon case, this means
the programmer can set the reader's fieldnames attribute to None at any time
and have the next row read as the next set of fieldnames, so a csv file can
contain several "sections", each with different fieldnames.
2003-10-03 14:03:01 +00:00
Fred Drake
1dc3bb4722
Work around minor markup issue: we don't want markup to escape into
...
the module index.
2003-09-30 20:00:43 +00:00
Andrew M. Kuchling
7cf4d9bf19
[Bug #812936 ] Correct the documentation for RotatingFileHandler.
...
[2.3 bugfix candidate]
2003-09-26 13:45:18 +00:00
Raymond Hettinger
9a80c5dbc4
Added codec for bz2 compression.
2003-09-23 20:21:01 +00:00
Raymond Hettinger
7e43110f34
SF 810242. Fix doubled word errors.
2003-09-22 15:00:55 +00:00
Raymond Hettinger
1e80359733
Clean-up example code: remove string module and backticks.
2003-09-22 06:25:10 +00:00
Martin v. Löwis
e7a9796a0f
Patch #800697 : Add readline.clear_history.
2003-09-20 16:08:33 +00:00
Martin v. Löwis
7bdc484c97
Patch #808362 : Fix typos.
2003-09-20 11:09:28 +00:00
Raymond Hettinger
d21fd7bd86
* Minor wording change
...
* Reference the doctest.DocTestSuite() conversion tool.
2003-09-16 22:04:31 +00:00
Raymond Hettinger
3404034a21
Minor fixups
2003-09-16 21:45:22 +00:00
Raymond Hettinger
1e4cf67c32
SF bug #804113 : Crypto terminology for crypto hash function
...
Noted that the SHA algorithm is really SHA-1.
(Contributed by Ronald Rivest.)
2003-09-15 18:20:52 +00:00
Raymond Hettinger
deadbf50e4
SF #662923
...
Add support for the iterator and mapping protocols.
For Py2.3, this was done for shelve, dumbdbm and other mapping objects, but
not for bsddb and dbhash which were inadvertently missed.
2003-09-12 06:33:37 +00:00
Raymond Hettinger
74c8e55f3b
SF bug #804280 : fromkeys is not listed in index
2003-09-12 00:02:37 +00:00
Fred Drake
614438ab06
fix markup buglets
2003-09-11 18:18:54 +00:00
Fred Drake
7c4d8f3ca9
- add version annotation for HIGHEST_PROTOCOL
...
- cleaned up some markup
2003-09-10 20:47:43 +00:00
Brett Cannon
62dba4c277
select.select() now accepts a sequence (as defined by PySequence_Fast()) for
...
its first three arguments.
Closes RFE #798046 .
2003-09-10 19:37:42 +00:00
Skip Montanaro
fd4fa8801a
mention new module doc display feature of pydoc in libref and NEWS
2003-09-10 19:04:13 +00:00
Raymond Hettinger
6e380cd1d8
SF bug #803679 : Missing section number in csv module documentation
2003-09-10 18:54:49 +00:00
Raymond Hettinger
5bcc933211
SF bug #803842 : Wrong description of regexp concatenation
2003-09-10 18:45:12 +00:00
Raymond Hettinger
0d6e8cde1a
SF bug #802302 : Invalid documentation for dbhash.
...
The documentation severely departed for the actual implementation.
2003-09-10 04:44:29 +00:00
Raymond Hettinger
bed92ee2b2
SF patch #800899 : Making "|" directive from REs a bit clearer.
2003-09-10 03:54:50 +00:00
Raymond Hettinger
9756f388c0
Fix typo.
2003-09-10 00:11:28 +00:00
Fred Drake
f5f0c17b85
end-of-sentence punctuation comes *before* \footnote, not after
2003-09-09 19:49:18 +00:00
Raymond Hettinger
dfa7bd97ff
SF #801306 : Bad RE in scanf example
2003-09-09 01:30:13 +00:00
Raymond Hettinger
74923d73ee
SF bug #560286 : Add docs for 'basestring'
2003-09-09 01:12:18 +00:00
Raymond Hettinger
a098b33c93
Add an example to address a common question of how to split iterators.
2003-09-08 23:58:40 +00:00
Raymond Hettinger
b67449d31d
Fix spacing markup and other sundries.
2003-09-08 18:52:18 +00:00
Fred Drake
60e868abd2
- reorganize sections
...
- correct section level error (module references are always \section)
- many markup revisions, including some minor rewordings
2003-09-06 17:51:16 +00:00
Raymond Hettinger
99812134be
SF bug 799191: fix markup
2003-09-06 05:47:31 +00:00
Raymond Hettinger
1c90a6754c
SF bug 799367: grammar error
2003-09-06 05:36:13 +00:00
Raymond Hettinger
951976dc9f
SF bug #801486 : Markup error.
2003-09-06 04:39:54 +00:00
Fred Drake
74530ff4f9
markup updates
2003-09-05 15:50:20 +00:00
Martin v. Löwis
ef36537b81
Patch #792338 : Correct documentation for timetuple return type.
2003-09-04 18:29:53 +00:00
Martin v. Löwis
25f90d5c5d
Use de_DE in example, change message for unknown locale. Fixes #797447 .
...
Will backport to 2.3.
2003-09-03 04:50:13 +00:00
Raymond Hettinger
09c7b6075c
SF patch #798255 : Document httplib.HTTPResponse.read "amt" argument
...
(Contributed by Jeff Epler.)
2003-09-02 02:32:54 +00:00
Raymond Hettinger
aa1178b811
Minor typo
2003-09-01 23:13:04 +00:00
Raymond Hettinger
c75c3e0392
SF patch #791153 : inconsistency with implementation(logging)
...
(Contributed by George Yoshida.)
2003-09-01 22:50:52 +00:00
Raymond Hettinger
6f6d7b93bc
SF bug #797853 : Small problems with the csv module's documentation
2003-08-31 05:44:54 +00:00
Raymond Hettinger
2f3e5483a3
SF bug #732120:An extended definition of "non-overlapping" would save time.
...
Clarified the meaning of non-overlapping in patterns with zero length
matches.
2003-08-31 05:29:02 +00:00
Raymond Hettinger
0a6aa28681
SF patch #797157 : Bug 794658: os.chmod docs, stat constants
...
(Contributed by Christos Georgiou.)
Reference the symbol definitions in the stat module.
2003-08-31 05:09:52 +00:00
Raymond Hettinger
9d12ab5c3c
Fix long option markup.
2003-08-31 04:20:12 +00:00
Raymond Hettinger
8170200ce2
SF patch #797180 : Bug 792656: slicing explained
2003-08-30 23:31:31 +00:00
Fred Drake
4f4dbef2ca
remove extra word occurance; reported to webmaster
2003-08-27 15:11:40 +00:00
Raymond Hettinger
9e3864190c
Make the derived tools amendable to cut and paste.
2003-08-25 05:06:09 +00:00
Raymond Hettinger
999b57c872
Fix double word typos.
2003-08-25 04:28:05 +00:00
Raymond Hettinger
9ac25ec025
SF bug #793702 : Section 13.1 HTMLParser documentation error
...
The -- is special to TeX and was printing as just -.
2003-08-25 03:31:28 +00:00
Barry Warsaw
463c5a868f
Update get_param() description to reflect changes to the docstring.
2003-08-19 04:26:59 +00:00
Raymond Hettinger
6a1801271a
Improvements to set.py:
...
* Relaxed the argument restrictions for non-operator methods. They now
allow any iterable instead of requiring a set. This makes the module
a little easier to use and paves the way for an efficient C
implementation which can take better advantage of iterable arguments
while screening out immutables.
* Deprecated Set.update() because it now duplicates Set.union_update()
* Adapted the tests and docs to include the above changes.
* Added more test coverage including testing identities and checking
to make sure non-restartable generators work as arguments.
Will backport to Py2.3.1 so that the interface remains consistent
across versions. The deprecation of update() will be changed to
a FutureWarning.
2003-08-17 08:34:09 +00:00
Raymond Hettinger
7ceb29e4a5
Incorporate documentation suggestions from feedback on comp.lang.python.
...
* Positive wording for the description of why < and > and = can all
be False.
* Move to a three column table format that puts long method names
side-by-side with their operator equivalents
* Mention that KeyError can be raised by Set.pop() and Set.remove().
* Minor tweaks to the examples.
Will backport as soon as Fred rebuilds the docs so I can confirm
the tables formatted properly
2003-08-16 00:56:40 +00:00
Raymond Hettinger
fb857893a2
SF patch #787929 : reflect the introduce of boolean type(libcfgparser.tex)
...
(Contributed by George Yoshida.)
2003-08-14 19:58:35 +00:00
Fred Drake
8fd8def1fa
fix markup
2003-08-14 04:51:24 +00:00
Andrew M. Kuchling
69f31eb80c
[Patch #739124 ] Add use_default_colors() to curses module
2003-08-13 23:11:04 +00:00
Raymond Hettinger
f17d65da3a
SF patch#786531 'the the' typo. Contributed by George Yoshida
2003-08-12 00:01:16 +00:00
Skip Montanaro
bc961e5714
add a statement identifying StringI and StringO objects.
2003-08-11 15:06:07 +00:00
Raymond Hettinger
6e13bcc7b1
SF bug #775836 : change 0,1 to False,True in dict.has_key doc
2003-08-08 11:07:59 +00:00
Raymond Hettinger
b5a420883c
Modified itertools.izip() to match the behavior of __builtin__.zip()
...
which can now take zero arguments.
2003-08-08 05:10:41 +00:00
Raymond Hettinger
c7d7766fda
Improve docs:
...
* Simplify the pure python examples
* Add a quantify() example
2003-08-08 02:40:28 +00:00
Raymond Hettinger
f8a52d38ad
Removed deprecated functions
2003-08-05 12:23:19 +00:00
Raymond Hettinger
02771c174c
SF patch #782810 : typo in libfuture.tex
...
(Contributed by George Yoshida)
2003-08-05 11:40:21 +00:00
Martin v. Löwis
cebcc61d4d
Patch #781126 : Fix markup for add_fallback. Will backport to 2.3.
2003-08-05 05:54:15 +00:00
Brett Cannon
b278ac4e46
Add note about fileno not being usable as a normal file descriptor in Windows.
2003-08-05 03:51:24 +00:00
Raymond Hettinger
4ee2ff36d0
Clarified that TypeErrors can be raised by any
...
function (not just builtins).
The issue arose in a thread on comp.lang.python.
2003-08-04 08:33:50 +00:00
Raymond Hettinger
eaef615116
As discussed on python-dev, changed builtin.zip() to handle zero arguments
...
by returning an empty list instead of raising a TypeError.
2003-08-02 07:42:57 +00:00
Fred Drake
9d843087b6
update the documentation contact address
2003-07-30 02:55:28 +00:00
Fred Drake
d50bd6cf00
Update URL.
2003-07-28 14:39:13 +00:00
Raymond Hettinger
88821f7c20
Important usability fix in itertools documentation.
2003-07-22 06:33:13 +00:00
Fred Drake
ef13949e00
Avoid a 301 permanent redirect.
...
Part of SF patch #773007 .
2003-07-22 00:49:11 +00:00
Fred Drake
6c4970995a
Merge the old dumbdbm documetation into the new docs that have been added.
...
Make some module references hyperlinks.
2003-07-21 15:30:15 +00:00
Raymond Hettinger
476fcae4d7
SF bug #774411 : Typo in socket documentation
2003-07-20 01:10:15 +00:00
Fred Drake
7a6b4f0284
more markup chages
2003-07-17 16:00:01 +00:00
Fred Drake
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
Raymond Hettinger
943277ecd3
Minor corrections.
2003-07-17 14:47:12 +00:00
Fred Drake
38d7c1bb78
Note that Unicode strings are now supported in sys.path.
...
SF patch #764594 .
2003-07-17 04:22:44 +00:00
Skip Montanaro
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
Skip Montanaro
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
Raymond Hettinger
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
Fred Drake
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
Fred Drake
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
Fred Drake
d24c767d5b
A variety of markup-level adjustments.
2003-07-16 05:17:23 +00:00
Raymond Hettinger
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
Fred Drake
d9cf8e7e7c
Markup consistency nits.
2003-07-14 21:07:05 +00:00
Fred Drake
9753ae1237
Added missing markup.
2003-07-14 20:53:57 +00:00
Raymond Hettinger
708c2a877e
Fix unbalanced parenthesis in text.
2003-07-14 18:36:47 +00:00
Raymond Hettinger
0e53d234eb
Fix missing parenthesis
2003-07-14 18:24:26 +00:00
Skip Montanaro
7233117960
update norobots link
2003-07-14 17:04:50 +00:00
Skip Montanaro
a2d3d93ee3
+ libdumdbm
2003-07-14 12:13:27 +00:00
Skip Montanaro
d54c5ddd28
minimal dumdbm module doc
2003-07-14 12:12:37 +00:00
Raymond Hettinger
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
Raymond Hettinger
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
Raymond Hettinger
627273733f
SF bug #770107 : Typo in documentation of resource module
2003-07-13 00:46:40 +00:00
Martin v. Löwis
162f081fb3
Patch 549151, rev4: redirect posts for 301 also. Will backport to 2.2.
2003-07-12 07:33:32 +00:00
Raymond Hettinger
92f21b13ea
Document Jim Fulton's docttest extensions.
2003-07-11 22:32:18 +00:00
Raymond Hettinger
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
Neal Norwitz
a4d2b869b9
Add versionadded. Remove duplicate "to"
2003-07-09 12:41:55 +00:00
Kurt B. Kaiser
0b1782f7c0
Document interrupt_main()
...
Remove obsolete reference to deprecated exit_thread() function
2003-07-08 17:07:20 +00:00
Neal Norwitz
dd3afa75b3
add missing '
2003-07-08 16:26:34 +00:00
Fred Drake
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
Fred Drake
8120995b56
Update Tkinter3000 notes based on text from Fredrik Lundh.
2003-07-08 13:44:27 +00:00
Anthony Baxter
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
Neal Norwitz
7cb229df18
add versionadded for getcheckinterval
2003-07-07 14:11:53 +00:00
Tim Peters
e5e065b669
New function sys.getcheckinterval(), to complement setcheckinterval().
2003-07-06 18:36:54 +00:00
Neal Norwitz
b25229d823
Fix SF bug #766288 , property() example gives syntax error
2003-07-05 17:37:58 +00:00
Skip Montanaro
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
Skip Montanaro
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
Raymond Hettinger
774816f817
SF bug #764616 : execfile(filename,...) not execfile(file,...)
...
Clarify parameter name.
2003-07-02 15:31:54 +00:00
Raymond Hettinger
f8020e0211
Grammar nit. SF bug #757822
2003-07-02 15:10:38 +00:00
Fred Drake
c5528b1f5c
Revert the previous change; this is now dealt with in a better way.
2003-07-02 14:44:55 +00:00
Fred Drake
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
Fred Drake
2884d6de15
Fix a variety of small markup nits.
2003-07-02 12:27:43 +00:00
Fred Drake
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
Tim Peters
93ceaea01f
showwarning() calls formatwarning(), not showwarning().
...
Bugfix candidate.
2003-07-01 14:37:59 +00:00
Raymond Hettinger
9c8f78deab
Improve the wording a bit
2003-07-01 07:19:17 +00:00
Raymond Hettinger
69d6356eb9
Fix spelling, grammar, usage, and markup.
2003-07-01 06:29:18 +00:00
Brett Cannon
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
Neal Norwitz
ecc7171007
Add versionadded info for the 2 new threading module functions
2003-06-30 21:47:47 +00:00
Fred Drake
5728815e7b
Fix broken markup, & tweak a couple of things for consistency.
2003-06-29 18:12:23 +00:00
Jeremy Hylton
bfccb35b58
Add settrace() and setprofile() functions to the threading library.
2003-06-29 16:58:41 +00:00
Raymond Hettinger
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
Raymond Hettinger
3567a876c7
Add take() to examples. Tighten the islice() example
2003-06-28 05:44:36 +00:00
Fred Drake
5d2f515dd4
fix markup nits
2003-06-28 03:09:06 +00:00
Raymond Hettinger
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
Tim Peters
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
Fred Drake
f91888bb46
markup consistency nits
2003-06-26 03:11:57 +00:00
Raymond Hettinger
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
Raymond Hettinger
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
Raymond Hettinger
35fd926195
SF bug #757822 : Additional index items, other minor details
...
* Minor grammatical fix.
2003-06-25 15:07:45 +00:00
Martin v. Löwis
9e9a7c3dd7
Patch #640236 : Better eplain unused data.
2003-06-21 14:15:25 +00:00
Barry Warsaw
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
Neal Norwitz
3a03de4a27
SF #757229 , fix libsocket.tex typo
2003-06-20 17:11:39 +00:00
Skip Montanaro
f5ed9819b0
Avoid using 'dir' as a variable name and use os.path.join() to create
...
paths.
2003-06-19 18:10:37 +00:00
Raymond Hettinger
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
Raymond Hettinger
b5155e30ce
Fix typo.
2003-06-18 01:58:31 +00:00
Walter Dörwald
93719b56ed
Updated documentation for the new slice arguments for list.index().
2003-06-17 16:19:56 +00:00
Skip Montanaro
364ca40c2a
SF Patch 569574 - enhancements to cgitb for plain text display
2003-06-17 12:58:31 +00:00
Neal Norwitz
938b7a0f63
Fix some markup nits
2003-06-17 02:37:06 +00:00
Tim Peters
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
Raymond Hettinger
7e902b27e0
* Added missing documentation for object().
...
* Noted the Py2.3 in the optional arg for bool().
2003-06-11 09:15:26 +00:00
Raymond Hettinger
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
Raymond Hettinger
132fa373d1
Add docs for get_grouped_opcodes().
2003-06-11 07:50:44 +00:00
Raymond Hettinger
80b3f685b4
SF bug: 751941 Invisible HTML tag
...
Added missing jump target labels.
2003-06-10 21:41:22 +00:00
Barry Warsaw
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
Raymond Hettinger
e07b83591f
Document context_diff() and unified_diff()
2003-06-09 21:44:59 +00:00
Neal Norwitz
305908cffd
SF #735051 , add time.tzset documentation
2003-06-08 13:57:19 +00:00
Gustavo Niemeyer
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
Skip Montanaro
a1045567e0
QUOTE_ALWAYS -> QUOTE_ALL
2003-06-04 15:30:13 +00:00
Martin v. Löwis
19a5a710fc
Patch #744238 : Explain that different string types also may compare equal.
2003-05-31 08:05:49 +00:00
Martin v. Löwis
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
Neal Norwitz
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
Neal Norwitz
d3d5768e5e
isdatadescriptor() was added recently.
2003-05-29 02:10:31 +00:00
Greg Ward
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
Gregory P. Smith
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
Jeremy Hylton
c428112d29
Rename lib__future__.tex to libfuture.tex and add link in lib.tex.
2003-05-28 11:57:52 +00:00
Gregory P. Smith
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
Greg Ward
451a766953
More wordsmithing and cleanup.
2003-05-26 01:51:33 +00:00
Greg Ward
c316d0d391
Lots of wordsmithing and typographical improvement.
2003-05-23 02:44:46 +00:00
Jeremy Hylton
e41195fab6
Add documentation for __future__
2003-05-21 21:45:01 +00:00
Fred Drake
15eac1f95c
Fix markup nits.
2003-05-20 16:21:51 +00:00
Tim Peters
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
Fred Drake
e5a55519a8
Remove unused line numbers from example code.
...
Line numbering of examples is not used elsewhere.
2003-05-20 15:21:08 +00:00
Brett Cannon
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
Skip Montanaro
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
Walter Dörwald
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
Guido van Rossum
8f512a22cd
Add docs for MessageBeep.
2003-05-16 01:42:22 +00:00
Andrew M. Kuchling
7696344182
[Bug #471893 ] Replace security material with a warning against unpickling
...
untrusted data.
2003-05-14 16:51:46 +00:00
Fred Drake
126d366ea6
document Stats.dump_stats(), new for Python 2.3
2003-05-14 14:29:27 +00:00
Guido van Rossum
bf1bef820c
Add optional 'onerror' argument to os.walk(), to control error
...
handling.
2003-05-13 18:01:19 +00:00
Andrew M. Kuchling
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
Andrew M. Kuchling
eabd9a1314
[Bug #729817 ] Document the rexec and Bastion modules as dead
2003-05-13 14:16:18 +00:00
Andrew M. Kuchling
032bd0a9a8
Fix typo
2003-05-13 14:13:58 +00:00
Brett Cannon
1213bdd16d
Fix and add reference to urllib.urlencode for parse_qsl? functions.
2003-05-13 02:50:36 +00:00
Raymond Hettinger
bf3a75283c
Fix minor typos.
2003-05-12 03:23:51 +00:00
Fred Drake
8f53cdcfce
- object is a class type, not a function
...
- when marking a function, the trailing () should be included
consistently
2003-05-10 19:46:39 +00:00
Raymond Hettinger
b4c1d9be8f
Fix unbalanced parethesis.
2003-05-10 08:51:28 +00:00
Raymond Hettinger
0dfd7a9361
Missing parenthesis found by texcheck.py
2003-05-10 07:40:56 +00:00
Martin v. Löwis
5467d4c0e3
Patch #612627 : Add encoding attribute to file objects, and determine
...
the terminal encoding on Windows and Unix.
2003-05-10 07:10:12 +00:00
Raymond Hettinger
eca984fcce
Fix missing parenthesis.
2003-05-10 04:21:08 +00:00
Raymond Hettinger
52136a8bea
Fixed spacing and unbalanced brackets or parenthesis.
2003-05-10 03:35:37 +00:00
Fred Drake
9f545c489a
Make this format again.
2003-05-09 19:10:12 +00:00
Skip Montanaro
a30dffbb53
add a note about accessing user-defined functions with an import statement
...
in the setup parameter
2003-05-09 18:21:02 +00:00
Fred Drake
3ec4dfd812
Make this format again.
2003-05-09 18:18:46 +00:00
Fred Drake
8b6ed26dc7
- remove bogus \end{description}
...
- fix two typos
2003-05-09 15:04:56 +00:00
Greg Ward
86e1790cad
Clarify the dedent() example a bit by indenting the input lines unevenly.
2003-05-08 02:12:35 +00:00
Greg Ward
8f6329c547
SF patch #598163 (Ville Vainio, vvainio@users.sourceforge.net):
...
document dedent() function.
2003-05-08 02:09:49 +00:00
Brett Cannon
066f3928b2
Library documentation for the 'test' package. Still needs to be checked by Fred.
2003-05-07 22:02:17 +00:00
Skip Montanaro
6d9f45bc3f
add a note about the undocumented bsddb185 module
2003-05-06 20:40:17 +00:00
Jeremy Hylton
6cb52ddc3c
Refer reader to platform library docs for specific semantics.
...
Resolves SF bugs 697989, 697988, 697986.
2003-05-05 16:46:26 +00:00
Greg Ward
d72312857e
Scattered wording and typographical improvements (up to but not
...
including the "Callback Options" section).
2003-05-03 21:22:58 +00:00
Greg Ward
649625bc05
Rename "The Tao of Option Parsing" section to "Philosophy".
...
Remove first-person usage from it. Various wording tweaks.
2003-05-03 20:41:37 +00:00
Greg Ward
1f53517a8c
Use True/False instead of 1/0 when talking about store_true/store_false.
...
Particularly important since they now store True and False rather than 1
and 0!
2003-05-03 20:13:08 +00:00
Greg Ward
c50b088cfd
Add a big comment about cross-platform issues (especially OpenBSD).
...
This should be turned into a footnote by someone who actually
understands OSS and its relationship to Linux, FreeBSD, OpenBSD, NetBSD,
etc.
2003-05-03 19:45:47 +00:00
Greg Ward
bf8f1b55a8
Use TeX quotes -- ``foo'' -- as appropriate.
...
Remove whitespace around em-dashes.
2003-05-03 19:41:45 +00:00
Greg Ward
b4e3319302
Fix various markup errors: use \longprogramopt{} more, and use it
...
correctly. (Closes SF #731689.) Use \emph{} in a few places.
2003-05-03 19:16:36 +00:00
Martin v. Löwis
ec31047c0c
Use \versionchanged, not \versionadded.
2003-05-03 10:59:13 +00:00
Martin v. Löwis
7829e5661c
Patch #731514 : Update recursion documentation to mention simple recursion.
2003-05-03 10:57:53 +00:00
Martin v. Löwis
e59e2bab8f
Patch #711902 : Cause pydoc to show data descriptor __doc__ strings.
2003-05-03 09:09:02 +00:00
Raymond Hettinger
341deb74e7
The previous made the stop argument optional.
...
It is better to be explicit and just allow stop to be None.
2003-05-02 19:44:20 +00:00
Raymond Hettinger
14ef54cd83
SF bug #730685 : itertools.islice stop argument is not optional
...
* itertools.islice() stop argument did not perform as documented.
* beefed-up test suite
2003-05-02 19:04:37 +00:00
Fred Drake
90fc0b356f
At the site of an indexed reference to print, point to the relevant
...
documentation. Closes SF bug #723136 .
2003-04-30 16:44:36 +00:00
Fred Drake
d4be747e1e
- comment out \moduleauthor that broke formatting until the formatting
...
tools can be fixed; added XXX comment
- general markup fixes
2003-04-30 15:02:07 +00:00
Fred Drake
c95628e3f2
- clean up some extra punctuation hidden in indexing markup
...
- fix a typo and one markup nit
- normalize whitespace
2003-04-29 13:56:40 +00:00
Fred Drake
83c19ee06b
Clarify that the timeout argument to read_until() is in seconds.
2003-04-29 13:39:05 +00:00
Raymond Hettinger
6e887bb05f
SF bug #729096 : getopt online documentation example improvement
...
A newbie found it difficult to translate the exampe into a
case that used only short options or long options but not both.
He tried to shorten the tuple search but forgot the trailing comma,
The appropriate pattern is an equality check.
Revised the example to point him in the right direction.
Backport candidate.
2003-04-29 04:35:36 +00:00
Brett Cannon
a2f8737faf
Add comment that urlopen opens local files without universal newlines
2003-04-29 04:11:12 +00:00
Tim Peters
a1af767c4d
Reworded fabs() for consistency with the others. Noted that all
...
return values are floats.
2003-04-28 21:32:03 +00:00
Tim Peters
a390c6e194
walk() docs: Emphasize that the recursive-delete example is dangerous.
2003-04-28 19:15:10 +00:00
Tim Peters
5501b5e3d7
SF bug 728097: tmpnam problems on windows 2.3b, breaks test.test_os.
...
tmpnam() appears essentially useless on Windows, and it finally broke
the test for Irmen de Jong. Read the long new comment in test_tmpnam()
for details. Since the MS implementation is insane, it might be good
if we supplied a different implementation.
Bugfix candidate.
2003-04-28 03:13:03 +00:00
Tim Peters
bf89b3a1f7
walk() docs: Worked "walking" into the description and the text. Added
...
a brief example where bottom-up walking is essential.
2003-04-28 02:09:43 +00:00
Tim Peters
965697fc4b
Clarified new text about math exceptions.
...
Bugfix candidate.
2003-04-26 15:11:08 +00:00
Skip Montanaro
5118341530
Add note about platform-specific behavior arising from discussion on bug
...
711019.
2003-04-26 02:59:00 +00:00
Fred Drake
9635268ea9
organizational and markup cleansing
2003-04-25 18:02:34 +00:00
Fred Drake
d198f38505
- add availability statements for some of the new APIs
...
- lots of general cleanup
2003-04-25 16:16:02 +00:00
Fred Drake
53e5b71bbc
Add modified versions of the examples from Sean Reifschneider
...
(SF patch #545480 ).
2003-04-25 15:27:33 +00:00
Guido van Rossum
b016752d8b
Fix a copy-paste error: the paragraph about inet_ntop's use was copied
...
literally from inet_pton.
2003-04-25 15:26:58 +00:00
Skip Montanaro
5d0136e297
reflect csv's change back to a module. Document the new sniffer api.
2003-04-25 15:14:49 +00:00
Fred Drake
9f48045ec0
Use a simpler \note instead of a "See also" section to refer to the
...
os.walk() generator.
2003-04-25 15:12:47 +00:00
Neal Norwitz
6eb502f267
Add versionadded for has_ipv6 attribute
2003-04-25 14:53:48 +00:00
Neal Norwitz
cabf56f8b4
Fix markup
2003-04-25 14:52:41 +00:00
Fred Drake
2194a4eede
markup adjustments
2003-04-25 14:50:06 +00:00
Tim Peters
c4e0940042
New generator os.walk() does a bit more than os.path.walk() does, and
...
seems much easier to use. Code, docs, NEWS, and additions to test_os.py
(testing this sucker is a bitch!).
2003-04-25 07:11:48 +00:00
Guido van Rossum
47dfa4a89a
Patch by Jp Calderone:
...
- The socket module now provides the functions inet_pton and inet_ntop
for converting between string and packed representation of IP addresses.
See SF patch #658327 .
This still needs a bit of work in the doc area, because it is not
available on all platforms (especially not on Windows).
2003-04-25 05:48:32 +00:00
Andrew M. Kuchling
f8d0c075b2
[Patch #628208 ] Document the allow_none argument
2003-04-25 00:29:31 +00:00
Skip Montanaro
3bd3c8403a
* minor tweaks relating to the package nature of the beast
...
* added an (incomplete) description of the utils.Sniffer class
2003-04-24 18:47:31 +00:00
Barry Warsaw
50889239c3
Updated a bunch of docs to describe how message ids and strings are
...
Unicode in GNUTranslations. Also provide better descriptions of
*gettext() overridden methods, esp. w.r.t. the behavior in the face of
fallbacks.
2003-04-24 18:14:49 +00:00
Fred Drake
d859d470a1
Add cross-references between urllib.urlencode() and cgi.parse_qs[l]().
...
Closes SF bug #724751 .
2003-04-24 16:22:47 +00:00
Raymond Hettinger
024aaa1bfe
SF Patch 549151: urllib2 POSTs on redirect
...
(contributed by John J Lee)
2003-04-24 15:32:12 +00:00
Fred Drake
1d5854fdc4
Note the platform module.
2003-04-24 15:24:46 +00:00
Andrew M. Kuchling
bbb9a55327
[Patch #679505 ] Document that this module is deprecated
2003-04-24 13:19:09 +00:00