Commit Graph

3278 Commits

Author SHA1 Message Date
Fred Drake a180581511 use conventional whitespace in interactive example 2003-12-31 07:41:52 +00:00
Guido van Rossum 50e7a11af1 Correct misrepresentation of print (it uses str(), not `...` for
conversion).  Hopefully I've not messed up the formatting.
2003-12-31 06:32:38 +00:00
Fred Drake af78512712 - general markup cleanup
- rearrange so two small sections become one; this avoids an extra
  page in the HTML format
2003-12-31 05:18:46 +00:00
Fred Drake 7f8d17a50c general markup improvements 2003-12-31 05:01:23 +00:00
Fred Drake 188b2d6cfa - add link to the datetime module 2003-12-31 04:52:36 +00:00
Fred Drake ceb1fd2177 - update description of isleap()
- add link to the datetime module
2003-12-31 04:51:56 +00:00
Fred Drake 6f51a72a61 - use the same markup for the deprecation as for that of
file.xreadlines()
2003-12-31 04:41:47 +00:00
Fred Drake ae55d5f3cb - add a "See also" reference to the doctest module
- slightly simplify a couple of examples
- clean up some markup
2003-12-31 04:34:50 +00:00
Fred Drake 32fef9f477 fix truly evil markup typo 2003-12-30 23:08:14 +00:00
Fred Drake ea49de34c9 minor cleanup of example 2003-12-30 23:01:19 +00:00
Fred Drake ff381e13e0 - we *really* don't care about Python 1.5 alphas any more!
- note the interpreter's -S option
2003-12-30 22:51:32 +00:00
Fred Drake 401d1e3cbf fix a variety of markup bugs 2003-12-30 22:21:18 +00:00
Fred Drake f161c915bd work around whitespace bugs in the HTML version 2003-12-30 22:17:16 +00:00
Fred Drake dcf32a676e fix markup errors 2003-12-30 20:48:59 +00:00
Fred Drake b0e8f5d0fe lots of markup adjustments 2003-12-30 20:36:20 +00:00
Fred Drake 7c67cb8fba markup fix 2003-12-30 17:17:17 +00:00
Fred Drake 4922cae1e1 - remove crufty markup that's no longer needed to make the
presentation work right (and didn't work anyway)
- fix minor typo
2003-12-30 16:18:23 +00:00
Fred Drake 42713109d9 use consistent email address for Tim 2003-12-30 16:15:35 +00:00
Fred Drake 34929f23f5 - update Tim's email address
- remove spurious blank lines
2003-12-30 16:12:27 +00:00
Andrew M. Kuchling 91ca8de6f4 [Bug #850818] Accept Gregory H. Ball's suggested rewrite of a confusing description 2003-12-23 17:01:38 +00:00
Andrew M. Kuchling 7a3786cc55 [Bug #857821] Remove mention of deprecated string.{atol,atof} functions. (Patch from Gerrit Holl) 2003-12-23 16:53:34 +00:00
Fred Drake 828f847d66 minor markup adjustment 2003-12-18 20:58:34 +00:00
Andrew M. Kuchling 3435820842 Fix typo 2003-12-18 13:28:35 +00:00
Fred Drake 852fe0689a fix loss of a space after indexing markup 2003-12-18 06:26:56 +00:00
Raymond Hettinger b606b3d08a Guido grants a Christmas wish:
sorted() becomes a regular function instead of a classmethod.
2003-12-17 20:50:46 +00:00
Raymond Hettinger 64958a15d7 Guido grants a Christmas wish:
sorted() becomes a regular function instead of a classmethod.
2003-12-17 20:43:33 +00:00
Hye-Shik Chang c6f066f9a3 Update documentations for str.rsplit() with Alex Martelli's rewrite. 2003-12-17 02:49:03 +00:00
Hye-Shik Chang 3ae811b57d Add rsplit method for str and unicode builtin types.
SF feature request #801847.
Original patch is written by Sean Reifschneider.
2003-12-15 18:49:53 +00:00
Skip Montanaro 6485a87b9a missing word (should backport - is release23-maint still locked?) 2003-12-15 14:38:57 +00:00
Jeremy Hylton c1be59f40a SF patch 852995: add processors feature to urllib2
John J. Lee writes: "the patch makes it possible to implement
functionality like HTTP cookie handling, Refresh handling,
etc. etc. using handler objects. At the moment urllib2's handler
objects aren't quite up to the job, which results in a lot of
cut-n-paste and subclassing. I believe the changes are
backwards-compatible, with the exception of people who've
reimplemented build_opener()'s functionality -- those people would
need to call opener.add_handler(HTTPErrorProcessor).

The main change is allowing handlers to implement
methods like:

http_request(request)
http_response(request, response)

In addition to the usual

http_open(request)
http_error{_*}(...)
"

Note that the change isn't well documented at least in part because
handlers aren't well documented at all.  Need to fix this.

Add a bunch of new tests.  It appears that none of these tests
actually use the network, so they don't need to be guarded by a
resource flag.
2003-12-14 05:27:34 +00:00
Neal Norwitz 378f7b5dca Add a versionadded tag for traceback.format_exc() 2003-12-13 22:34:09 +00:00
Guido van Rossum 5a92175fbc After hearing from someone who gave up on timeout sockets due to a
mistake in his code, I'm adding a note explaining that you should call
settimeout() before connect().
2003-12-13 22:12:53 +00:00
Brett Cannon 35415da67c Fix broken link (closes bug #852236). Thanks to Fedor Baart for bug file and
finding proper link.
2003-12-11 04:37:24 +00:00
Raymond Hettinger ff294fea40 SF patch #855195: fix typos
(Contributed by George Yoshida.)
2003-12-07 13:00:25 +00:00
Raymond Hettinger 295530585b Fix double hyphen markup. 2003-12-07 12:46:16 +00:00
Raymond Hettinger e3d5f98180 Put str() in alphabetical order. 2003-12-07 11:24:03 +00:00
Raymond Hettinger a4ce2f5116 SF bug #855317: unittest: 5.3.9 Getting Extended Error Information
The example code did not work and could not easily be made to work.
Since the docs were already complex and the feature was not used
(it took two years for the errors to surface), we decided to dedocument
it entirely, leaving unittest cleaner than before.
2003-12-07 10:48:03 +00:00
Andrew M. Kuchling db7dcffa27 Edit description a bit 2003-12-06 22:29:43 +00:00
Raymond Hettinger d25c1c6351 Implement itertools.groupby()
Original idea by Guido van Rossum.
Idea for skipable inner iterators by Raymond Hettinger.
Idea for argument order and identity function default by Alex Martelli.
Implementation by Hye-Shik Chang (with tweaks by Raymond Hettinger).
2003-12-06 16:23:06 +00:00
Raymond Hettinger ff6dd0b7d0 SF bug #844123: "up" instead of "down" in turtle module documentation 2003-12-06 01:35:56 +00:00
Fred Drake f96dd83bb4 - fix markup in the bool() description
- note the behavior of bool() with no arg in the main body of the
  description
2003-12-05 18:57:00 +00:00
Walter Dörwald c8de4585a6 Add parameters indent, width and depth to pprint.pprint() and pprint.pformat()
and pass them along to the PrettyPrinter constructor.
2003-12-03 20:26:05 +00:00
Raymond Hettinger 166958b5df As discussed on python-dev, added two extractor functions to the
operator module.
2003-12-01 13:18:39 +00:00
Martin v. Löwis ccabed35ee Patch #849350: Update to document bool return values. Backported to 2.3. 2003-11-27 19:48:03 +00:00
Martin v. Löwis 94681fc4a3 Patch #849595: Add socket.shutdown() constants. 2003-11-27 19:40:22 +00:00
Raymond Hettinger d4462300db Nits from a review of the documentation update. 2003-11-26 17:52:45 +00:00
Neal Norwitz 72452650af Add version changed doc for addition of fillchar to ljust/rjust/center 2003-11-26 14:54:56 +00:00
Raymond Hettinger 4f8f976576 Add optional fillchar argument to ljust(), rjust(), and center() string methods. 2003-11-26 08:21:35 +00:00
Raymond Hettinger bd93b3ea8f As discussed on python-dev, banish apply(), buffer(), coerce(), and
intern() to a separate region in the docs.
2003-11-25 21:48:21 +00:00
Raymond Hettinger f5f41bf087 * Checkin remaining documentation
* Add more tests
* Refactor and neaten the code a bit.
* Rename union_update() to update().
* Improve the algorithms (making them a closer to sets.py).
2003-11-24 02:57:33 +00:00
Tim Peters 5a5b243043 More words: gave more motivation, and added cautions about the special
dangers of trying to iterate over weak dicts.
2003-11-21 22:20:57 +00:00
Barry Warsaw 65367ca41e Add a missing import. Closes SF # 816344. 2003-11-21 20:28:15 +00:00
Martin v. Löwis af7dc8d8b8 Patch #831747: Add skip_accept_encoding parameter to putrequest. 2003-11-19 19:51:55 +00:00
Barry Warsaw f8d3bcc77e Generator's constructor: The documentation was incorrect regarding how
header wrapping gets done when maxheaderlen <> 0.  The header really
gets wrapped via the email.Header.Header class, which has a more
sophisticated algorithm than just splitting on semi-colons.
2003-11-19 02:22:36 +00:00
Martin v. Löwis 8bafb2aaca Patch #843088: Fix typos. Backported to 2.3. 2003-11-18 19:48:57 +00:00
Raymond Hettinger a690a9967e * Migrate set() and frozenset() from the sandbox.
* Install the unittests, docs, newsitem, include file, and makefile update.
* Exercise the new functions whereever sets.py was being used.

Includes the docs for libfuncs.tex.  Separate docs for the types are
forthcoming.
2003-11-16 16:17:49 +00:00
Raymond Hettinger d456849f19 Fix typo 2003-11-16 13:44:19 +00:00
Gregory P. Smith b845ef056a remove "support" for BerkeleyDB 3.1, it hasn't worked for a long time 2003-11-13 08:30:03 +00:00
Raymond Hettinger ad983e79d6 Improve the implementation of itertools.tee().
Formerly, underlying queue was implemented in terms of two lists.  The
new queue is a series of singly-linked fixed length lists.

The new implementation runs much faster, supports multi-way tees, and
allows tees of tees without additional memory costs.

The root ideas for this structure were contributed by Andrew Koenig
and Guido van Rossum.
2003-11-12 14:32:26 +00:00
Fred Drake d85ed1b7fc fix typo in markup 2003-11-10 14:50:54 +00:00
Fred Drake dbe7980d6a add missing "if" 2003-11-10 14:43:16 +00:00
Martin v. Löwis 75aa4db04b Mention that getsid is new in 2.4. 2003-11-10 06:46:15 +00:00
Martin v. Löwis d8921379e9 Patch #798297: Add IMAP THREAD command. 2003-11-10 06:44:44 +00:00
Martin v. Löwis 49ee14dac5 Patch #839038: Add getsid(2). 2003-11-10 06:35:36 +00:00
Alex Martelli 37dc334276 Add docs for readmodule_ex and its function-descriptors, fixing
sf bug#812818.
(same as commit of Sun Nov 2 to the release23-maint branch)
2003-11-09 16:32:54 +00:00
Alex Martelli 50324a604c Avoid giving advice that's bad for security, as per SF bug #823515
(same as commit of Sun Nov 2 to the release23-maint branch)
2003-11-09 16:31:18 +00:00
Raymond Hettinger 85c20a41df Implement and apply PEP 322, reverse iteration 2003-11-06 14:06:48 +00:00
Neil Schemenauer f607fc5395 Add traceback.format_exc(). 2003-11-05 23:03:00 +00:00
Raymond Hettinger 83c187460e SF patch #834444: add versionadd to new functions
(Contributed by George Yoshida.)
2003-11-02 09:50:56 +00:00
Andrew M. Kuchling b4b9ced1b6 [Bug #817178] Fix incorrect arguments in example, noted by Terry Reedy 2003-10-31 19:52:30 +00:00
Martin v. Löwis 893ffa4372 Patch #830858: Correct the number of is-functions. Backported to 2.3 and 2.2. 2003-10-31 15:35:53 +00:00
Martin v. Löwis 45394c281d Patch #531629: Add multicall support. 2003-10-31 13:49:36 +00:00
Martin v. Löwis 48440b7c27 Patch #: Add POP3 over SSL support. 2003-10-31 12:52:35 +00:00
Raymond Hettinger 9885c93b99 Fix typo. 2003-10-30 06:08:32 +00:00
Brett Cannon 82b24827f6 Minor grammatical fix. 2003-10-30 05:42:15 +00:00
Raymond Hettinger 0a9b9da0c3 Add list.sorted() classmethod. 2003-10-29 06:54:43 +00:00
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