Commit Graph

7124 Commits

Author SHA1 Message Date
Edward Loper aec3c9b54f Added a new NORMALIZE_NUMBERS option, which causes number literals in
the expected output to match corresponding number literals in the
actual output if their values are equal (to ten digits of precision).
2004-09-28 04:29:57 +00:00
Edward Loper 1793dd31de Fixed minor typo in interactive example (extra '.'s in '...' prompts) 2004-09-28 03:12:01 +00:00
Edward Loper dcdb4b4d78 Fixed minor typo in interactive example (extra blank line) 2004-09-28 03:08:57 +00:00
Raymond Hettinger 78a5271d3e SF bug #1033038: Misleading error message in random.choice
Added a clarifying line to the docs.
2004-09-28 03:04:23 +00:00
Edward Loper ad512265a5 Fixed minor typo in interactive example 2004-09-28 02:56:45 +00:00
Edward Loper 3077b02ff4 Fixed minor typo in interactive example (backslash shouldn't be doubled) 2004-09-28 02:54:54 +00:00
Edward Loper a7f62814cf Updated interactive examples in the "Examples" session to reflect the
fact that compiler.ast.Function now takes a "decorators" argument.
2004-09-28 02:53:50 +00:00
Greg Ward b6f7fb7327 Major overhaul to reflect Optik 1.5. Section references currently broken. 2004-09-28 01:30:23 +00:00
Armin Rigo b6aa856f25 Patch #1009075, bug #952953: allow execve with empty 2nd argument 2004-09-27 19:54:33 +00:00
Edward Loper a4c6a8522c - Added a "parser" option to testfile() and DocFileTest(). 2004-09-27 04:08:20 +00:00
Edward Loper 456ff91664 - Fixed typo in multi-line exception example
- Fixed indentation for a verbatim block
2004-09-27 03:30:44 +00:00
Tim Peters 36ee8ce373 Give a saner example for script_from_examples(); also mention an intended
but not entirely obvious use case.
2004-09-26 21:51:25 +00:00
Tim Peters 9463d8761b Made most module references "clickable". 2004-09-26 21:05:03 +00:00
Tim Peters 0041121c25 Docs for run_docstring_examples(). 2004-09-26 20:45:04 +00:00
Tim Peters 05b05febad Added a lot of new stuff to the debugging section. 2004-09-26 05:09:59 +00:00
Tim Peters 16be62f054 register_optionflag(): Moved from the Debugging section to the section
on option flags; added a versionadded decoration.
2004-09-26 02:38:41 +00:00
Tim Peters 6a0a64b7ad Document set_unittest_reportflags(). 2004-09-26 02:12:40 +00:00
Raymond Hettinger c90ea82302 Fix double word error. 2004-09-25 08:09:23 +00:00
Tim Peters 3f7912521d Assorted minor changes, plus a lot more soap. 2004-09-25 03:50:35 +00:00
Tim Peters 8c0a2cf938 Explain the motivation for the unittest functions, and beef up the
example.  Squash repeated argument descriptions.  Minor rewordings.
2004-09-25 03:02:23 +00:00
Tim Peters b2b26aca13 Repaired mistakes in the descriptions of testmod()/testfile(), and
squashed massive duplication of common argument descriptions.
2004-09-25 01:51:49 +00:00
Tim Peters 2dc820599b Since the doctest warnings section was reduced to one bullet point,
get rid of the itemize structure.
2004-09-25 01:30:16 +00:00
Tim Peters 39c5de0376 In the "doctest warnings" section, removed obsolete info, and noted that
ELLIPSIS can be used to deal with examples that embed object addresses.
2004-09-25 01:22:29 +00:00
Johannes Gijsbers 24f141ab46 Raymond observed that sometimes it's better not to link modules, so I reverted
part of my previous last changes.
2004-09-25 00:55:38 +00:00
Tim Peters 06cc847cee Beef up the section on testfile(), giving a complete example in
reStructuredText format.  Remove words describing the return value of
testmod() and testfile() in the intro sections, since it's never
useful in such simple cases.
2004-09-25 00:49:53 +00:00
Tim Peters cac5e7b81d Typo. 2004-09-25 00:11:43 +00:00
Tim Peters 7a082142d8 Since the LaTeX isn't doctest'ed, examples are always wrong <wink>. 2004-09-25 00:10:53 +00:00
Johannes Gijsbers 27ebcae450 - Use itemize instead of plain-text '*' for marking up a list.
- Add more ulink's to modules (this should probably become a standard macro).
2004-09-24 23:25:25 +00:00
Vinay Sajip 739d49e39b Added log() function documentation 2004-09-24 11:46:44 +00:00
Raymond Hettinger 596ba4d89e Granted Noam Raphael's request for minor improvements to the re module and
its documentation.

* Documented that the compiled re methods are supposed to be more full
  featured than their simpilified function counterparts.

* Documented the existing start and stop position arguments for the
  findall() and finditer() methods of compiled regular expression objects.

* Added an optional flags argument to the re.findall() and re.finditer()
  functions.  This aligns their API with that for re.search() and
  re.match().
2004-09-24 03:41:05 +00:00
Andrew M. Kuchling 9fa544cfa3 Update for beta1 2004-09-23 20:17:26 +00:00
Andrew M. Kuchling 0c7895617f Add various items 2004-09-23 20:15:41 +00:00
Raymond Hettinger 4533f1fb7f Improve three recipes in the itertools docs. 2004-09-23 07:27:39 +00:00
Vinay Sajip c6646c097a Added getLoggerClass() 2004-09-22 12:55:16 +00:00
Edward Loper b3666a3da2 - Updated docs to reflect changes in 2.4.
- Reorganized the documentation
  - Shifted focus a little more towards "literate testing"
  - Documented new functions and classes:
    - testfile()
    - Example, DocTest
    - DocTestParser, DocTestFinder, DocTestRunner, OutputChecker
    - DocFileSuite
    - DebugRunner, DocTestFailure, UnexpectedException
    - register_optionflag()
2004-09-21 03:00:51 +00:00
Raymond Hettinger 468af71214 Fix minor grammar typo. 2004-09-20 17:47:46 +00:00
Edward Loper 6cc1350807 - Updated example output to match actual output
- Minor wording changes
- Changed the docs to reflect the fact that multiple option directives
  can be specified on a single line (and updated the directive
  production list, as well).
2004-09-19 01:16:44 +00:00
Barry Warsaw 33db656dbf Update Template/PEP 292 documentation to current implementation. 2004-09-18 21:13:43 +00:00
Martin v. Löwis 39a317890f Patch #1025790: Add status code constants to httplib. 2004-09-18 09:03:49 +00:00
Fred Drake 2e6fb4634c remove gzipped archives from the list of expected distributions 2004-09-17 20:23:47 +00:00
Martin v. Löwis 266a436fe2 Remove claims that Python source code is ASCII. Fixes #1026038. 2004-09-14 07:52:22 +00:00
Raymond Hettinger 879ddf30d0 Tweak the wording. Improve examples. Make more brief. 2004-09-14 06:32:20 +00:00
Raymond Hettinger 29c6a79b7d Cover string.Template in the tutorial's library tour. 2004-09-14 05:21:42 +00:00
Raymond Hettinger 23f1241dc6 SF #1027105: HardwareRandom should be renamed OSRandom
Renamed the new generator at Trevor's recommendation.
The name HardwareRandom suggested a bit more than it
delivered (no radioactive decay detectors or such).
2004-09-13 22:23:21 +00:00
Andrew M. Kuchling 7642f7af0d Credit patch from Raymond 2004-09-13 15:06:50 +00:00
Tim Peters 8278860e52 Document testmod's new exclude_empty argument. 2004-09-13 15:03:17 +00:00
Tim Peters 2ee8099bd8 HtmlDiff corrections from Dan Gass, + trimmed trailing whitespace. 2004-09-12 03:21:00 +00:00
Johannes Gijsbers 6ab4b99f95 Patch #1025795: clarify language in Data Structures chapter of tutorial:
- Dictionary keys are in arbitrary order, but not random (which implies, well,
  intentional randomness).
- Move a footnote closer to what it's talking about so that it doesn't look
  like we're saying that "0 == 0.0" can't be relied on.
- Minor language tweaks in the vicinity.

Thanks Dima Dorfman!
2004-09-11 17:48:21 +00:00
Johannes Gijsbers 2014c033f7 Patch #1022152: add required 'domain' argument to gettext.translation() examples. 2004-09-11 17:33:25 +00:00
Johannes Gijsbers d345225ae5 Patch #1026384: fix two common typo's:
- accomodate -> accommodate
- occured -> occurred

Thanks George Yoshida!
2004-09-11 16:50:06 +00:00
Johannes Gijsbers c9c37ca62e Patch #1025800: remove TeX quoting from verbatim section. Thanks Dima Dorfman! 2004-09-11 15:47:30 +00:00
Andrew M. Kuchling f08437ca08 [Bug #1023359] Make code match inheritance diagram 2004-09-10 19:33:00 +00:00
Andrew M. Kuchling a331e86452 Add some stdlib items; remove 'other changes' section; fix sorting error in list of changed modules 2004-09-10 13:05:22 +00:00
Andrew M. Kuchling 55be9eab38 Typo fix: 'comparisions' is not a word 2004-09-10 12:59:54 +00:00
Andrew M. Kuchling 2cc0c3008c Bump version number 2004-09-10 12:38:36 +00:00
Andrew M. Kuchling a79ec22f9f Update PEP292 section 2004-09-10 11:34:39 +00:00
Fred Drake 961c2882a9 document the exceptions raised by sgmllib, htmllib, and HTMLParser 2004-09-10 01:20:21 +00:00
Fred Drake a2544ee7f0 fix typo in markup 2004-09-10 01:16:49 +00:00
Fred Drake 216b249e94 make_nav_panel(): Don't cause side-effects on the input variables;
this caused duplicate attributes for the bottom navigation panel.

(closes SF patch #1013055; backport candidate)
2004-09-09 05:13:52 +00:00
Walter Dörwald 69652035bc SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
decoding incomplete input (when the input stream is temporarily exhausted).
codecs.StreamReader now implements buffering, which enables proper
readline support for the UTF-16 decoders. codecs.StreamReader.read()
has a new argument chars which specifies the number of characters to
return. codecs.StreamReader.readline() and codecs.StreamReader.readlines()
have a new argument keepends. Trailing "\n"s will be stripped from the lines
if keepends is false. Added C APIs PyUnicode_DecodeUTF8Stateful and
PyUnicode_DecodeUTF16Stateful.
2004-09-07 20:24:22 +00:00
Raymond Hettinger 8158e84930 Fix erroneous docstring comment. 2004-09-06 07:04:09 +00:00
Raymond Hettinger 785c65ccd2 Markup nits. 2004-09-06 01:01:08 +00:00
Raymond Hettinger bb30af4565 Add missing close parenthesis. 2004-09-06 00:42:14 +00:00
Raymond Hettinger 18c6960964 SF bug #901654: split method documentation can be improved
* Discuss the algorithmic distinctions between s.split() and s.split(sep).
* Document the split behavior for empty strings.
* Note the behavior when maxsplit is zero.
* Include short examples.
2004-09-06 00:12:04 +00:00
Brett Cannon 1b262977a0 Rework some wording. 2004-09-05 19:42:15 +00:00
Raymond Hettinger 2a72f19528 SF bug #1020540: a wrong link from "frame object" in lib index 2004-09-04 21:14:34 +00:00
Tim Peters 1fbf9c5ec1 Added IGNORE_EXCEPTION_DETAIL comparison option. The need is explained
in the new docs.

DocTestRunner.__run:  Separate the determination of the example outcome
from reporting that outcome, to squash brittle code duplication and
excessive nesting.
2004-09-04 17:21:02 +00:00
Gustavo Niemeyer a01a2ee933 Applying modified version of patch #1018386, which fixes
some escaping bugs in SRE.
2004-09-03 17:06:10 +00:00
Skip Montanaro 0bbf137fbd Make the api of the _dispatch() method more concrete. I have no idea if
this is the right way to document such things (Fred, help me out here :-),
but I got misled by the existing documentation and assumed the parameter
list was a *args sort of thing.
2004-09-03 00:04:05 +00:00
Fred Drake 410eb84a5d - add missing \end{seealso}
- wrap long line
2004-09-01 04:05:08 +00:00
Andrew M. Kuchling 3d3db9663f Add item 2004-08-31 13:57:02 +00:00
Andrew M. Kuchling ecd5754925 Remove rotor reference 2004-08-31 13:49:36 +00:00
Andrew M. Kuchling 595ac8a6fc Remove rotor license 2004-08-31 13:24:08 +00:00
Andrew M. Kuchling ab459f71d6 Remove docs for xreadlines, mpz, rotor 2004-08-31 13:22:43 +00:00
Andrew M. Kuchling e723863ba1 Remove xreadlines reference 2004-08-31 13:21:07 +00:00
Andrew M. Kuchling a46fd8480f Remove TERMIOS docs 2004-08-31 13:05:59 +00:00
Andrew M. Kuchling e4133d8d67 Use correct constant; remove reference to TERMIOS.py 2004-08-31 13:05:36 +00:00
Andrew M. Kuchling e34c3bd621 Change from Raymond: use pos/neg instead of +/- 1; minor edits 2004-08-31 12:21:44 +00:00
Andrew M. Kuchling ab77822826 Describe non-recursive re 2004-08-31 12:07:43 +00:00
Andrew M. Kuchling b07aae28c5 Add bug/patch counts 2004-08-31 11:54:22 +00:00
Andrew M. Kuchling 3294e9d2e7 Update versions and dates; add PEP 328 2004-08-31 11:26:23 +00:00
Vinay Sajip 17952b78e1 Updated doc for getLogger() 2004-08-31 10:21:51 +00:00
Anthony Baxter 1a4ddaecc7 SF patch #1007189, multi-line imports, for instance:
"from blah import (foo, bar
baz, bongo)"
2004-08-31 10:07:13 +00:00
Tim Peters 38330fe5ef The distinction between comparison flags and reporting flags isn't unique
to unittest, so make it official:  new module constants COMPARISON_FLAGS
and REPORTING_FLAGS, which are bitmasks or'ing together the relevant
individual option flags.

set_unittest_reportflags():  Reworked to use REPORTING_FLAGS, and
simplified overly complicated flag logic.

class FakeModule:  Removed this; neither documented nor used.
2004-08-30 16:19:24 +00:00
Johannes Gijsbers ed047486f5 Fix build error: \filename{/dev/urandom} -> \file{/dev/urandom}. 2004-08-30 15:03:23 +00:00
Andrew M. Kuchling cb7b3f30d6 Add items 2004-08-30 11:58:04 +00:00
Johannes Gijsbers ae882f7984 Patch #941486: add os.path.lexists(). Also fix bug #940578 by using lexists in glob.glob. 2004-08-30 10:19:56 +00:00
Raymond Hettinger 356a4599ac Teach the random module about os.urandom().
* Use it for seeding when it is available.
* Provide an alternate generator based on it.
2004-08-30 06:14:31 +00:00
Martin v. Löwis e064b41f5a Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. 2004-08-29 16:34:40 +00:00
Martin v. Löwis dc3883f671 Patch #934711: Expose platform-specific entropy. 2004-08-29 15:46:35 +00:00
Raymond Hettinger 6ab78cd0c0 SF feature request #992967: array.array objects should support sequences.
Made the constructor accept general iterables.
2004-08-29 07:50:43 +00:00
Johannes Gijsbers 592ef6110f Correct incorrect "it's" to "its". 2004-08-26 10:40:12 +00:00
Tim Peters f33683fd40 Fine tune a word. 2004-08-26 04:52:46 +00:00
Tim Peters cf53355fcf Thinko repair. 2004-08-26 04:50:38 +00:00
Tim Peters a07bcd46f3 Reorg of exception section. Now that there are fewer details needing
explanation, it's easier to push the remaining insufferably anal details
into a "fine print" section at the bottom.
2004-08-26 04:47:31 +00:00
Raymond Hettinger f4fd79ca49 Small wording fixups. 2004-08-26 03:11:56 +00:00
Edward Loper a89f88d53f Added REPORT_ONLY_FIRST_FAILURE flag, which supresses output after the
first failing example in each test.
2004-08-26 02:45:51 +00:00
Edward Loper 71f55af826 Renamed UNIFIED_DIFF->REPORT_UDIFF; CONTEXT_DIFF->REPORT_CDIFF; and
NDIFF_DIFF->REPORT_NDIFF.  This establishes the naming convention that
all reporting options should begin with "REPORT_" (since reporting
options are a different class from output comparison options; but they
are both set in optionflags).
2004-08-26 01:41:51 +00:00
Tim Peters 0e448073d6 Restored half of a \versionadded only half of which should have been
deleted.
2004-08-26 01:02:08 +00:00
Dave Cole e8bbfe4e63 Patch #1015012. Improve markup and punctuation in libsocket.tex 2004-08-26 00:51:16 +00:00
Dave Cole 3203efb55f Patch #1014930. Expose current parse location to XMLParser. 2004-08-26 00:37:31 +00:00
Edward Loper 19b1958730 Only recognize the expected output as an exception if it *starts* with
a traceback message.  I.e., examples that raise exceptions may no
longer generate pre-exception output.  This restores the behavior of
doctest in python 2.3.  The ability to check pre-exception output is
being removed because it makes the documentation simpler; and because
there are very few use cases for it.
2004-08-25 23:07:03 +00:00
Fred Drake e3a1b4888c clean up markup for --executable description 2004-08-25 14:01:32 +00:00
Andrew M. Kuchling 87c98b2e4b Add various items 2004-08-25 13:38:46 +00:00
Martin v. Löwis 9f5c0c41ce Patch #736857, #736859: Add -e option to build_scripts. 2004-08-25 11:37:43 +00:00
Martin v. Löwis be83737c7c Patch #798244: More urllib2 examples. 2004-08-25 11:24:42 +00:00
Martin v. Löwis 8d494f3241 Patch #1015021: Stop claiming that coerce can return None.
Will backport to 2.3.
2004-08-25 10:42:41 +00:00
Barry Warsaw 08b07def43 Ah whoops, we didn't turn string into a package (thanks Neal!) 2004-08-25 03:09:58 +00:00
Barry Warsaw 8bee76106e PEP 292 classes Template and SafeTemplate are added to the string module.
This patch includes test cases and documentation updates, as well as NEWS file
updates.

This patch also updates the sre modules so that they don't import the string
module, breaking direct circular imports.
2004-08-25 02:22:30 +00:00
Tim Peters c885443479 Stop producing or using OverflowWarning. PEP 237 thought this would
happen in 2.3, but nobody noticed it still was getting generated (the
warning was disabled by default).  OverflowWarning and
PyExc_OverflowWarning should be removed for 2.5, and left notes all over
saying so.
2004-08-25 02:14:08 +00:00
Dave Cole 07fda7e3a0 Updated the socketpair() docstring and documentation to explain that the
default famility is AF_UNIX if defined for the platform, otherwise the
default is AF_INET.
2004-08-23 05:16:23 +00:00
Tim Peters 656f7e4b40 Removed redundant versionadded{} for NDIFF_DIFF. Virtually everything
in this section is new in 2.4, and that's all mentioned already in
versionadded{} thingies at the end of the section.  It hurts readability
to have them after every line <wink>.
2004-08-23 00:26:42 +00:00
Neal Norwitz 8bd5cb342c Add version info 2004-08-22 21:48:37 +00:00
Tim Peters c6cbab0db4 Added NDIFF_DIFF option. 2004-08-22 19:43:28 +00:00
Raymond Hettinger d3b0babf66 SF bug #1013760: Error in Chapter 4 of Tutorial
Fit a nit.
2004-08-22 15:24:33 +00:00
Neal Norwitz 5268c3955a sf #1009373, #1005936. fix underscores in index entries in PDF files.
I couldn't test this, but it didn't break anything and the patch
reported fixed the problem.

Bugfix candidate.
2004-08-21 15:13:52 +00:00
Neal Norwitz 7109b287cf Fix grammar, spotted by Hye-Shik Chang 2004-08-20 23:13:26 +00:00
Johannes Gijsbers 8e3bec5418 Correct argument specifications of load_compiled and load_source: the file
argument is optional on both (the format string is "ss|O!").
2004-08-20 14:38:56 +00:00
Johannes Gijsbers c89061817b Quote # as \# to make lib compile again. 2004-08-20 14:37:05 +00:00
Neal Norwitz 8623b36ee0 Try to improve grammar and use versionadded 2004-08-20 02:36:27 +00:00
Neal Norwitz 525b315326 Fix markup. versionchanged automatically adds a period, so remove the extra one. 2004-08-20 01:52:42 +00:00
Tim Peters 026f8dc103 Now that they've settled down, document doctest directives. 2004-08-19 16:38:58 +00:00
Martin v. Löwis 336e85f56a Patch #900727: Add Py_InitializeEx to allow embedding without signals. 2004-08-19 11:31:58 +00:00
Fred Drake c6f3c8b612 fix SF bug #1008690: Incorrect <link rel="index"> href in Tutorial
The make_head_and_body() function used a hardcoded value for the
<link> element for the index; this patch causes the proper output
filename to be captured during the transformation phase so it can be
used during the page assembly phase.
2004-08-19 01:37:48 +00:00
Matthias Klose cf02e31683 Remove commented definition of the MKHOWTO macro. 2004-08-18 22:27:04 +00:00
Matthias Klose 5b75f7d19b Remove zero-byte gif files from generated html docs 2004-08-18 22:17:44 +00:00
Martin v. Löwis 75b9da4aaf Patch #995126: Correct directory size, and generate GNU tarfiles by default. 2004-08-18 13:57:44 +00:00
Martin v. Löwis ae075b6cb7 Patch #1011144: Correct regex for coding decls. 2004-08-18 13:25:05 +00:00
Martin v. Löwis deacce2c87 Patch #800236: add HTTPResponse.getheaders(). 2004-08-18 12:46:26 +00:00
Raymond Hettinger 01884d56f4 Deprecate sys.exitfunc in favor of the atexit module.
Per Guido, sys.exitfunc will be kept around for backwards compatability
but atexit will become the one preferred way to do it.
2004-08-18 02:50:00 +00:00
Michael W. Hudson 0ccff074cd This is Mark Russell's patch:
[ 1009560 ] Fix @decorator evaluation order

From the description:

Changes in this patch:

- Change Grammar/Grammar to require
newlines between adjacent decorators.

- Fix order of evaluation of decorators
in the C (compile.c) and python
(Lib/compiler/pycodegen.py) compilers

- Add better order of evaluation check
to test_decorators.py (test_eval_order)

- Update the decorator documentation in
the reference manual (improve description
of evaluation order and update syntax
description)

and the comment:

Used Brett's evaluation order (see
http://mail.python.org/pipermail/python-dev/2004-August/047835.html)

(I'm checking this in for Anthony who was having problems getting SF to
talk to him)
2004-08-17 17:29:16 +00:00
Raymond Hettinger 8de636e2ae SF bug #951482: New module: doc versus action
Strengthen the warnings about creating bogus objects using the new module.
2004-08-17 02:31:55 +00:00
Raymond Hettinger cb40ba1f5e SF bug #805304: super instances don't support item assignment
Document a nuance of super().  It is designed to work well with dotted
attribute lookup but not with equivalent implicit lookups using operators
or statements.
2004-08-17 02:21:45 +00:00
Andrew M. Kuchling 7ec7584813 Typo fix 2004-08-16 16:12:23 +00:00
Raymond Hettinger d3fe2395b4 Minor improvements to the threading introduction:
* Expand the example to show a join.

* Mention the use case of I/O running concurrent with a computational
  thread.

* Be a tad more forceful about recommending Queue over other approaches
  to synchonization.

* Eliminate discussion around having a single interpreter.  This is a
  more advanced discussion that belongs in the library reference and
  in a section on extending and embedding.
2004-08-16 05:11:04 +00:00
Raymond Hettinger 8df4e6b020 Fix punctuation typo. 2004-08-15 23:51:38 +00:00
Raymond Hettinger 2864b808c7 Add a notes section to the docs:
* Discuss representation error versus loss of significance.
* Document special values including qNaN, sNaN, +0, -0.
* Show the suprising display of non-normalized zero values.
2004-08-15 23:47:48 +00:00
Raymond Hettinger 5c8d29cb13 SF patch #872326: generator expression implementation
(Contributed by Jiwon Seo.)

Add genexps to the reference manual.
2004-08-15 23:28:10 +00:00
Skip Montanaro e5069019e7 Add get_history_item and replace_history_item functions to the readline
module.  Closes patch #675551.  My apologies to Michal Vitecek for taking so
long to process this.
2004-08-15 14:32:06 +00:00
Johannes Gijsbers b112d6ed78 bug 990669: os.path.normpath may alter the meaning of a path if it contains
symbolic links. This has been documented in a comment since 1992, but is now in
the library reference as well.
2004-08-14 14:41:32 +00:00
Tim Peters 83e259a2c2 Another microburst of snail-like progress. 2004-08-13 21:55:21 +00:00
Tim Peters 41a65ea7fe Doctest has new traceback gimmicks in 2.4. While trying to document
them (which they are now), I had to rewrite the code to understand
it.  This has got to be the most DWIM part of doctest -- but in context
is really necessary.
2004-08-13 03:55:05 +00:00
Neal Norwitz 2e56c8a260 SF #1005913, Patch to allow building of paper-*/dist.pdf by Jeff Epler
There were subsections without sections, so drop a sub.
2004-08-13 02:56:16 +00:00
Neal Norwitz ee6511b309 Fix the version number in which changes were made 2004-08-13 02:34:06 +00:00
Tim Peters 2603960525 Markup fiddling. 2004-08-13 01:49:12 +00:00
Tim Peters 8a3b69ca8f Excruciatingly slow progress on the docs. Option flags / directive names
are documented now, and ripped out a bunch of "private name" convolutions.
2004-08-12 22:31:25 +00:00
Michael W. Hudson 5e897959db This is my patch
[ 1004703 ] Make func_name writable

plus fixing a couple of nits in the documentation changes spotted by MvL
and a Misc/NEWS entry.
2004-08-12 18:12:44 +00:00
Fred Drake 568671fc0f avoid version numbers in the text where possible 2004-08-10 21:20:10 +00:00
Fred Drake ba100c98ad clarify the behavior of the .first() and .last() methods for empty
databases

this should be backported to the release23-maint branch
2004-08-10 19:22:48 +00:00
Andrew M. Kuchling f54ac7e0ee Spelling fix 2004-08-10 19:01:50 +00:00
Fred Drake d62d507b9a added missing documentation for UseForeignDTD() (new in 2.3)
someone should backport to the release23-maint branch
2004-08-10 17:18:32 +00:00
Fred Drake fb568ca52a add descriptions for many of the new error codes 2004-08-10 16:47:18 +00:00
Fred Drake 9d92d5a9ac minor changes to make this format again 2004-08-10 15:41:03 +00:00
Tim Peters c2388a2b9c Start rewriting doctest's LaTeX docs. Damn, this is slow going! 2004-08-10 01:41:28 +00:00
Andrew M. Kuchling 24884a5ccc [Patch #1005465] Markup tweaks 2004-08-09 17:36:56 +00:00
Andrew M. Kuchling 7f203b847b Add item 2004-08-09 14:48:28 +00:00
Fred Drake 151df0794d - make a module reference a hyperlink
- wrap a long line
2004-08-09 14:12:05 +00:00
Fred Drake 830d8b8b80 fix markup nit 2004-08-09 14:06:58 +00:00
Dave Cole 9dc19c2515 Ooops - for some reason I had the wrong versionadded... 2004-08-09 05:59:09 +00:00
Dave Cole 331708b226 Patch #1003700: Add socketpair function to socket module. 2004-08-09 04:51:41 +00:00
Tim Peters feec4533e2 Bug 1003935: xrange overflows
Added XXX comment about why the undocumented PyRange_New() API function
is too broken to be worth the considerable pain of repairing.

Changed range_new() to stop using PyRange_New().  This fixes a variety
of bogus errors.  Nothing in the core uses PyRange_New() now.

Documented that xrange() is intended to be simple and fast, and that
CPython restricts its arguments, and length of its result sequence, to
native C longs.

Added some tests that failed before the patch, and repaired a test that
relied on a bogus OverflowError getting raised.
2004-08-08 07:17:39 +00:00
Andrew M. Kuchling 7219cbea8d Remove MacOS 9 ref 2004-08-07 21:35:06 +00:00
Andrew M. Kuchling c16affa811 Remove MacOS 9 refs 2004-08-07 21:33:44 +00:00
Andrew M. Kuchling 67ca703aca [Patch #862531] Update version numbers. 2004-08-07 21:30:13 +00:00
Andrew M. Kuchling 2ee6a7027a [Patch #999280 ] Update kwargs in pickle docs to match implementations 2004-08-07 20:25:55 +00:00
Andrew M. Kuchling 4eb1a00cc1 [Patch #1003861 from Dima Dorfman] Fix markup in concrete.tex:
PyObject* o -> PyObject *o to be consistent with the
rest of the file
- Correct markup for Py_True
- Remove duplicate description of PyBool_Check
2004-08-07 20:19:24 +00:00
Andrew M. Kuchling 672d2ba773 Use LaTeX markup 2004-08-07 20:17:48 +00:00
Andrew M. Kuchling 17e33e4c93 [Bug #914375] Crude modulefinder docs, but the module's code is very hard to read and it's not clear which bits are public and which aren't. The module's author should really be doing this (and using docstrings in the code, too) 2004-08-07 20:13:34 +00:00
Andrew M. Kuchling 32dbddafd5 Remove various modules that have been documented 2004-08-07 19:21:59 +00:00
Andrew M. Kuchling cbd81556bb [Bug #827209] Add footnote from Alex M. about listcomps leaking their index variables 2004-08-07 19:16:32 +00:00
Andrew M. Kuchling 59a27f1d6e Various minor edits 2004-08-07 19:10:36 +00:00
Andrew M. Kuchling 4cbe95cdd1 [Bug #866222] Update docs to match the module 2004-08-07 19:06:48 +00:00
Andrew M. Kuchling fe80b63663 [Bug #991883] Document calling condition 2004-08-07 17:53:05 +00:00
Michael W. Hudson 1baa248021 Fix
[ 1000841 ] "make pdf" failure w/ 2.4 docs

in the suggested way, by uglifying a URL.
2004-08-07 17:39:35 +00:00
Andrew M. Kuchling 0188cdb115 [Bug #998066] Mention result mismatch 2004-08-07 17:28:17 +00:00
Michael W. Hudson b6d9fc38e8 Patch:
[ 1003863 ] adds an index entry for __all__ to the tutorial
2004-08-07 17:05:42 +00:00
Andrew M. Kuchling 8def876d36 [Bug #873146] Document pickletools module (haven't tested the LaTeX yet) 2004-08-07 16:53:59 +00:00
Michael W. Hudson 049e7aaa0f Point out that the setdefault defaults the value to None. Inspired by
Michael Chermside's thinking about patch #748126 (the chief upshot of
which thinking was "reject it!").
2004-08-07 16:41:34 +00:00
Andrew M. Kuchling cbbee6fed5 [Bug #984952] Include more material from PEP 307.
I haven't tried to include all the material on old-style classes using protocols 0,1.  The details are lengthy; someone who knows
more about the pickle module should decide if they're important enough
to be in the docs or not.
2004-08-07 16:24:18 +00:00
Andrew M. Kuchling 14d535c3d4 [Bug #984952] Include some material from PEP 307 2004-08-07 15:49:24 +00:00
Andrew M. Kuchling 6f937b1c30 [Bug #998307] Use open() instead of file() in docs 2004-08-07 15:11:24 +00:00
Fred Drake 9bae19e8b1 fix two typos in markup 2004-08-07 14:28:37 +00:00
Andrew M. Kuchling e30c4d4ddc Add recent items 2004-08-07 13:58:02 +00:00
Andrew M. Kuchling 38dc2a6bf7 Simplify language 2004-08-07 13:24:12 +00:00
Andrew M. Kuchling ac6428756a Add string concat item 2004-08-07 13:13:31 +00:00
Andrew M. Kuchling ba59be04fa Bump version 2004-08-06 18:55:48 +00:00
Andrew M. Kuchling 34ed2b020a Typo fix; use 'in-place' instead of 'inplace' 2004-08-06 18:55:09 +00:00
Raymond Hettinger 52a21b8e65 SF patch #980695: efficient string concatenation
(Original patch by Armin Rigo).
2004-08-06 18:43:09 +00:00
Fred Drake 3f5c654deb fix markup nit, typo 2004-08-06 03:34:20 +00:00
Fred Drake 6bd8e842e4 update to reflect the new significance of the "@" character 2004-08-05 21:11:27 +00:00
Phillip J. Eby 1884dda233 Warn that settrace() is implementation rather than language
definition, per Guido's request  in off-list email.
2004-08-05 12:13:46 +00:00
Matthias Klose 4c8fa42aca Doc/lib/libfuncs.tex: correct items in itemize
Doc/dist/dist.tex: avoid uncommenting the verbose environment (by the py2texi tool)
2004-08-04 23:18:49 +00:00
Vinay Sajip 1cf56d0b8a Updated Logger.log() documentation to clarify that lvl parameter should be an integer. 2004-08-04 08:36:44 +00:00
Hye-Shik Chang e9ddfbb412 SF #989185: Drop unicode.iswide() and unicode.width() and add
unicodedata.east_asian_width().  You can still implement your own
simple width() function using it like this:
    def width(u):
        w = 0
        for c in unicodedata.normalize('NFC', u):
            cwidth = unicodedata.east_asian_width(c)
            if cwidth in ('W', 'F'): w += 2
            else: w += 1
        return w
2004-08-04 07:38:35 +00:00
Fred Drake f901abdd62 allow ctime(), gmtime(), and localtime() to take None as equivalent to an omitted arg
(closes SF bug #658254, patch #663482)
2004-08-03 17:58:55 +00:00
Fred Drake d04573fef0 This allows additional commands to be provided for existing setup.py
scripts without modifying either the distutils installation or the
setup.py scripts of packages with which the new commands will be used.

Specifically, an option is added to distutils that allows additional
packages to be searched for command implementations in addition to
distutils.command.  The additional packages can be specified on the
command line or via the installation or personal configuration files
already loaded by distutils.

For discussion, see the thread starting with:

http://mail.python.org/pipermail/distutils-sig/2004-August/004112.html

This closes SF patch #102241.
2004-08-03 16:37:40 +00:00
Fred Drake 2be406bd9f let's avoid the extra nesting where reasonable 2004-08-03 16:02:35 +00:00
Martin v. Löwis 9513e34ac4 Patch #823072: add option to NOT use ~/.netrc in nntplib.NNTP(). 2004-08-03 14:36:32 +00:00
Raymond Hettinger 70fcdb8be0 Document general mappings for the locals argument for exec and execfile(). 2004-08-03 05:17:58 +00:00
Fred Drake bec69f6a2e fix a little lie ;-( 2004-08-02 23:05:25 +00:00
Neal Norwitz 7fdd92f31f Fix typo though 2004-08-02 21:56:33 +00:00
Fred Drake e72bd4d621 fix markup error 2004-08-02 21:50:26 +00:00
Fred Drake 0c84c7f915 start filling in documentation on extending distutils 2004-08-02 21:39:11 +00:00
Andrew M. Kuchling 77a602fbf2 Add PEP318 2004-08-02 13:48:18 +00:00
Andrew M. Kuchling d91fcbe265 Add import change; add empty section for function decorators 2004-08-02 12:44:28 +00:00
Andrew M. Kuchling 1455f795e2 Update item 2004-08-02 12:09:58 +00:00
Raymond Hettinger 829d6c4138 Fix doubled word. 2004-08-02 08:36:07 +00:00
Anthony Baxter c2a5a63654 PEP-0318, @decorator-style. In Guido's words:
"@ seems the syntax that everybody can hate equally"
Implementation by Mark Russell, from SF #979728.
2004-08-02 06:10:11 +00:00
Tim Peters fd7dc5169c Typo repair. 2004-08-02 04:30:37 +00:00
Tim Peters 0c6199e8ed Completed a sentence I left dangling. 2004-08-02 04:14:10 +00:00
Tim Peters cfd575d398 PyImport_ImportModule, PyImport_ImportModuleEx, PyImport_ExecCodeModule:
in failure cases, incompletely initalized module objects are no longer
left behind in sys.modules.
2004-08-02 03:46:45 +00:00
Neal Norwitz 750f060ad7 SF bug #1001088, incorrect reference to macro named foo
Backport candidate.
2004-08-01 22:36:40 +00:00
Fred Drake 63a5d0b1cf re-wrap paragraphs containing long lines 2004-07-30 19:12:38 +00:00
Fred Drake 69013d070e - document the termination condition for cmd.Cmd.cmdloop()
- document the use of the return value for cmd.Cmd.do_*() methods
2004-07-30 18:58:54 +00:00
Martin v. Löwis 479b7a7cdb Fix typo. 2004-07-30 16:09:19 +00:00
Martin v. Löwis 8ddb638e43 Add closing methoddesc. Add versionadded. Rewrap. 2004-07-30 16:08:49 +00:00
Raymond Hettinger f9fd0d7988 SF bug #997533: "disjunct" should be "disjoint"
* Use plain wording in docs for id().
* Use normal quotation marks instead of single quotes in the description.
2004-07-29 06:06:34 +00:00
Neal Norwitz f9f0b21653 SF #998170, fix typo. Backport candidate 2004-07-29 03:48:59 +00:00
Skip Montanaro 6d3db7000e Add missing doc for Py_True/Py_False. Use the correct macro to define
Py_RETURN_FALSE and Py_RETURN_TRUE.
2004-07-29 02:16:04 +00:00
Andrew M. Kuchling 671c506737 Add new encodings 2004-07-28 15:29:39 +00:00
Skip Montanaro 33ee76ae9e A little boolean music if you please, maestro... (Not sure I have the
versionadded{} args quite right).
2004-07-28 14:17:04 +00:00
Neal Norwitz bee417439e Add versionadded info 2004-07-28 02:34:12 +00:00
Andrew M. Kuchling ce4bae6170 Add an item 2004-07-27 12:13:25 +00:00
Martin v. Löwis 7b9190b8fc Patch #998149: imaplib deleteacl and myrights. 2004-07-27 05:07:19 +00:00
Andrew M. Kuchling 5785a1391e Add some items 2004-07-26 19:28:46 +00:00
Andrew M. Kuchling e03664ff22 Two typo fixes 2004-07-26 19:25:54 +00:00
Andrew M. Kuchling e3e1ecacd5 [Bug #997166] Fix example 2004-07-26 18:52:48 +00:00
Fred Drake fdccf1ad6e fix information about what flag database files are opened with by default 2004-07-26 16:33:29 +00:00
Martin v. Löwis cc0f93233a Patch #605370: Add description[s] for RFC 2980 compliance. 2004-07-26 12:40:50 +00:00
Martin v. Löwis 37ead8f1c3 Patch #997668: Correct explanation of salts.
Will backport to 2.3.
2004-07-26 12:05:16 +00:00
Tim Peters abba5c067d Explain that most floats are actually integers. This is a common confusion
for people using floor(), ceil() and modf().
2004-07-26 05:12:01 +00:00
Tim Peters 9a729a1cc5 Typo in new docs. 2004-07-26 04:58:50 +00:00
Tim Peters d6ef19309d SF bugs 996748: os.environ documentation should indicate unreliability
Clarifed that os.environ is captured once; emphasized that it's better
to assign to os.environ than to call putenv() directly (the putenv()
docs said so, but the environ docs didn't).
2004-07-26 00:42:41 +00:00
Tim Peters 66bb6e661c SF bug 996392: math and cmath docs don't specify radians
Major rewrite of the math module docs.  Slapped in "radians" where
appropriate; grouped the functions into reasonable categories; supplied
many more words to address common confusions about some of the subtler
issues.
2004-07-24 23:00:24 +00:00
Thomas Heller fe0808382b Fix an uncorrect function prototype.
Will backport to release23-maint.

BTW: Shouldn't it read PY_LONG_LONG instead of 'long long' ?
2004-07-23 14:49:52 +00:00
Tim Peters 336689b9cc A few trivial edits. 2004-07-23 02:48:24 +00:00
Raymond Hettinger cab5b94592 SF bug #995983 and #995987: Documentation nits. 2004-07-22 19:33:53 +00:00
Gustavo Niemeyer 7bd33c5e22 This change implements the following gettext features, as
discussed recently in python-dev:

In _locale module:

- bind_textdomain_codeset() binding

In gettext module:

- bind_textdomain_codeset() function
- lgettext(), lngettext(), ldgettext(), ldngettext(),
  which return translated strings encoded in
  preferred system encoding, if
  bind_textdomain_codeset() was not used.
- Added equivalent functionality in translate()
  function and catalog classes.

Every change was also documented.
2004-07-22 18:44:01 +00:00
Andrew M. Kuchling c12527e2c7 [Bug #990524] Fix typo 2004-07-21 21:34:45 +00:00
Fred Drake 4ab0e9e541 revise wording to avoid confusion for non-native English speakers
(second occurance of the same wording)
2004-07-21 17:36:47 +00:00
Fred Drake 20938f57ba revise wording to avoid confusion for non-native English speakers 2004-07-21 17:18:19 +00:00
Vinay Sajip b4bf62f807 Added an extra example to the basic example section 2004-07-21 14:40:11 +00:00
Andrew M. Kuchling 0ad20f18fe Update Decimal section to match the current module 2004-07-21 13:00:06 +00:00
Andrew M. Kuchling 65a333219f Add PEP 331; add constancy of None; minor edits 2004-07-21 12:41:38 +00:00
Skip Montanaro bf76075a4b fix typo, highlight True/False correctly 2004-07-21 02:47:10 +00:00
Neal Norwitz 7728b4719e SF #994605, fcntl example is broken
The last call to fcntl (which wasn't changed) doesn't work for me, but
the first part works now.

Backport candidate.
2004-07-21 01:41:14 +00:00
Neal Norwitz d96d1015ef SF #918101, allow files >= 8 GB using GNU extension 2004-07-20 22:23:02 +00:00
Martin v. Löwis b0c319a905 Patch #993187: Make rstrip doc similar to lstrip.
Backported to 2.3.
2004-07-19 16:34:01 +00:00
Neal Norwitz 76aa2eff4e Get doc to build (add missing backslash) 2004-07-19 01:39:54 +00:00
Tim Peters 3d7d372ce3 Whitespace normalization, via reindent.py. 2004-07-18 06:25:50 +00:00