Commit Graph

3079 Commits

Author SHA1 Message Date
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
Brett Cannon 317ad7a5ee Fixed docs for urlretrieve() to match code in the case of opening a local file.
Also some typos and removed trailing whitespace on the lines.
2003-04-24 02:31:14 +00:00
Skip Montanaro 54a234a566 clarify - restrict version mention to the trunk version 2003-04-23 20:35:14 +00:00
Skip Montanaro 1bd1d858ae added note about character set limitations in passwords. 2003-04-23 20:22:12 +00:00
Tim Peters 2d1c846b73 Clarified new fsync() docs. 2003-04-23 19:47:14 +00:00
Tim Peters 11b2306960 Enable os.fsync() for Windows, mapping it to MS's _commit() there. The
docs here are best-guess:  the MS docs I could find weren't clear, and
some even claimed _commit() has no effect on Win32 systems (which is
easily shown to be false just by trying it).
2003-04-23 02:39:17 +00:00
Raymond Hettinger 863983e8e5 Add comment on performance.
Fix missing right parenthesis.
Add three examples.
2003-04-23 00:09:42 +00:00
Fred Drake 70995830a6 markup corrections 2003-04-22 18:54:53 +00:00
Fred Drake 282be3ab89 - explain the start argument to sum()
- various adjustments to sum() markup and explanation
2003-04-22 14:52:08 +00:00
Alex Martelli a70b19147f Adding new built-in function sum, with docs and tests. 2003-04-22 08:12:33 +00:00
Gustavo Niemeyer 48f3dcc93e - Changed shlex.split() method to have more useful and
meaningful parameters.
2003-04-20 01:57:03 +00:00
Gustavo Niemeyer cf146d31e7 - Included examples documenting how the lastindex member of
match objects work.
2003-04-20 01:48:59 +00:00
Martin v. Löwis 153c9e493e Patch #553171: Add writeback parameter. Also add protocol parameter. 2003-04-19 20:59:03 +00:00
Guido van Rossum a26854095b - Several methods of nntplib.NNTP have grown an optional file argument
which specifies a file where to divert the command's output
  (already supported by the body() method).  (SF patch #720468)
  Thanks to Terry Carroll.
2003-04-19 18:04:57 +00:00
Barry Warsaw b05df5796a Added some more documentation to as_string() to make it clear that
it's a convenience only.  Give an example of what to do for more
flexibility.
2003-04-18 23:03:53 +00:00
Martin v. Löwis 338bcbccfa Change email address. 2003-04-18 22:04:34 +00:00
Martin v. Löwis faf71ea5b3 Fix spelling of cedillas. 2003-04-18 21:48:56 +00:00
Martin v. Löwis 07d4fb6f17 Correct methoddesc environments. 2003-04-18 21:48:13 +00:00
Martin v. Löwis 281b2c6211 Patch #536883: SimpleXMLRPCServer auto-docing subclass. 2003-04-18 21:04:39 +00:00
Fred Drake cf6d74aedd - accepted (slightly) modified version of docs for the OptionGroup
class; closes SF patch #697941
- use em-dashes intead of en-dashes
- section references: use a "tie" between the word "section" and the
  section number, use quotation marks around section titles
- other minor markup corrections/cleanups
2003-04-18 15:50:13 +00:00
Martin v. Löwis 2548c730c1 Implement IDNA (Internationalized Domain Names in Applications). 2003-04-18 10:39:54 +00:00
Neal Norwitz 10cf21802d Use True in a few more places.
Use isinstance(somestring, basestring) instead of type() as per PEP 8
2003-04-17 23:09:08 +00:00
Neal Norwitz a6bdf2aef6 Oops, missed updating doc to correct version for split 2003-04-17 23:07:13 +00:00
Fred Drake 30b6e8230b Added documentation for the handle_pi() method, based on SF patch #662464.
Closes SF bug #659188, patch #662464.
2003-04-17 22:36:52 +00:00
Fred Drake aa3b5d2ec5 markup banalities 2003-04-17 21:49:04 +00:00
Gustavo Niemeyer 68d8cef89a Implemented posix-mode parsing support in shlex.py, as dicussed in
mailing list, and in patch #722686.
2003-04-17 21:31:33 +00:00
Neal Norwitz 1475c49211 Add version info for name2codepoint and codepoint2name 2003-04-16 13:21:06 +00:00
Walter Dörwald 5688b7ac3e Add two dictionaries to htmlentitydefs: name2codepoint maps
HTML entity names to Unicode codepoints (as integers).
codepoint2name is the reverse mapping. From SF patch #722017.
2003-04-16 09:46:13 +00:00
Guido van Rossum 3a3cca5b82 - list.insert(i, x) now interprets negative i as it would be
interpreted by slicing, so negative values count from the end of the
  list.  This was the only place where such an interpretation was not
  placed on a list index.
2003-04-14 20:58:14 +00:00
Andrew M. Kuchling 44c62ef5ee Typo fix 2003-04-14 15:32:18 +00:00
Barry Warsaw 125b9b0736 Back out of setting the default charset to iso-8859-1. 2003-04-11 21:28:10 +00:00
Neal Norwitz 06c7b62a83 Fix markup 2003-04-11 18:48:03 +00:00
Barry Warsaw a1ce93f87c From http://mail.python.org/pipermail/i18n-sig/2003-April/001557.html
- Expose NullTranslations and GNUTranslations to __all__

- Set the default charset to iso-8859-1.  It used to be None, which
would cause problems with .ugettext() if the file had no charset
parameter.  Arguably, the po/mo file would be broken, but I still think
iso-8859-1 is a reasonable default.

- Add a "coerce" default argument to GNUTranslations's constructor.  The
reason for this is that in Zope, we want all msgids and msgstrs to be
Unicode.  For the latter, we could use .ugettext() but there isn't
currently a mechanism for Unicode-ifying msgids.

The plan then is that the charset parameter specifies the encoding for
both the msgids and msgstrs, and both are decoded to Unicode when read.
For example, we might encode po files with utf-8. I think the GNU
gettext tools don't care.

Since this could potentially break code [*] that wants to use the
encoded interface .gettext(), the constructor flag is added, defaulting
to False.  Most code I suspect will want to set this to True and use
.ugettext().

- A few other minor changes from the Zope project, including asserting
that a zero-length msgid must have a Project-ID-Version header for it to
be counted as the metadata record.
2003-04-11 18:36:43 +00:00
Neal Norwitz ffe33b7f24 Attempt to make all the various string *strip methods the same.
* Doc - add doc for when functions were added
 * UserString
 * string object methods
 * string module functions
'chars' is used for the last parameter everywhere.

These changes will be backported, since part of the changes
have already been made, but they were inconsistent.
2003-04-10 22:35:32 +00:00
Fred Drake fcd845a7ed Lots of small markup adjustments. 2003-04-09 04:06:37 +00:00
Anthony Baxter fda5e27ec9 extra punctuation removed 2003-04-09 03:03:46 +00:00
Skip Montanaro d6e9fe386a + libtimeit 2003-04-09 01:39:06 +00:00
Skip Montanaro ca652746ff doc for timeit module/script - mostly just a recast of Tim's docstring 2003-04-09 01:38:53 +00:00
Fred Drake 2c2068c4d1 Added example of using positional and keyword args with atexit.register().
Based on a suggestion from a reader.
2003-04-08 17:46:53 +00:00
Fred Drake de7ad2caac Markup fix. 2003-04-08 17:37:47 +00:00
Tim Peters 730f5535ba s/referrents/referents/g. Gotta love that referrers remains rife with rs. 2003-04-08 17:17:17 +00:00
Tim Peters 0f81ab6d88 Finished implementing gc.get_referrents(): dealt with error and end
cases, wrote docs, added a test.
2003-04-08 16:39:48 +00:00
Anthony Baxter cb8ed53014 add note suggested by rhettinger about example. 2003-04-07 12:21:56 +00:00
Anthony Baxter b3303efec6 patch [ 698505 ] docs for hotshot module 2003-04-07 12:19:15 +00:00
Martin v. Löwis 3ae0f7a7cf Replace criterium with criterion. Fixes #705120. 2003-03-27 16:59:38 +00:00
Barry Warsaw bfa893f3ac email is at version 2.5 now 2003-03-21 21:14:48 +00:00
Skip Montanaro 5fbf8362a3 include csv doc section - Fred, you may want to change the location 2003-03-20 23:35:00 +00:00
Skip Montanaro b4a0417e91 new CSV file processing module - see PEP 305 2003-03-20 23:29:12 +00:00
Fred Drake 4cee220ff3 - added example of using a comparison function with list.sort(), and
explained the construction of a [(key, value), ...] list as an
  alternative
- note that support for cmpfunc=None was added in 2.3
2003-03-20 22:17:59 +00:00
Skip Montanaro 2a403e8a7e add descriptions of {get,set}defaulttimeout. 2003-03-20 17:58:12 +00:00
Fred Drake 5c7b2487cd - explain what a UNC path is in the makedirs() description, since
they're actually mentioned there
- remove some extraneous paragraph separations
- \versionadded --> \versionchanged in one place
2003-03-20 17:39:38 +00:00
Michael W. Hudson 43ed43bfc1 Take out my (long since disabled) POSIX signal mask handling code.
I'm not going to have the time or energy to get this working x-platform
-- anyone who does is welcome to the code!
2003-03-13 13:56:53 +00:00
Barry Warsaw 45c3941510 Update the package version number 2003-03-12 03:43:09 +00:00
Barry Warsaw a996d4f137 For email 2.5b1, we no longer add a trailing newline to
MIMEText.__init__()'s _text argument if it doesn't already end in a
newline.  This may be controversial.
2003-03-11 05:03:25 +00:00
Barry Warsaw 52b39f5b47 body_line_iterator() now takes a decode argument. 2003-03-11 04:40:14 +00:00
Barry Warsaw 20ebc37013 Describe what happens when decode=True and the payload has bogus
base64 data.
2003-03-10 16:13:50 +00:00
Greg Ward cd930f5258 openmixer()'s 'mode' parameter has been removed. 2003-03-10 03:18:19 +00:00
Greg Ward f882c77d70 Expand description of ossaudiodev.error exception.
Improve descriptions of open(), openmixer().
2003-03-10 03:05:21 +00:00
Greg Ward 3e34f59ce2 Rewrite intro paragraphs and add a "See also" box for the link to the
official OSS docs.

Markup fixes: change \code{} variously to \function{}, \method{}, or
\constant{} as appropriate.
2003-03-10 02:09:51 +00:00
Greg Ward 074472ba98 Fix two unformatted lists: one is now an 'enumerate' environment, the
other a 'tableii'.

Formatting/typo fix.
2003-03-10 00:24:42 +00:00
Greg Ward 41a28e374c Add libossaudiodev.tex. 2003-03-10 00:07:14 +00:00
Greg Ward 33bcd987dd Wrap all paragraphs to 72 columns.
Two spaces between sentences.
Fix em-dashes -- should be "---" not " - ".
Spelling fix.
2003-03-09 23:57:34 +00:00
Greg Ward 620e343c0a Documentation for the ossaudiodev module.
Initial revision supplied by Nicholas FitzRoy-Dale <wzdd@lardcave.net>
(emailed to me [gward@python.net] 2003-03-08 23:37 +1100).
2003-03-09 23:34:52 +00:00
Raymond Hettinger 42182ebaf6 SF 698520: Iterator for urllib.URLOpener
Contributed by Brett Cannon.
2003-03-09 05:33:33 +00:00
Raymond Hettinger a3e1e4cd79 SF patch #693753: fix for bug 639806: default for dict.pop
(contributed by Michael Stone.)
2003-03-06 23:54:28 +00:00
Barry Warsaw 1a2c37316b Describe Charset.__repr__(). 2003-03-06 06:07:34 +00:00
Barry Warsaw f32e313914 Describe the new Header.encode() argument "splitchars". 2003-03-06 06:06:54 +00:00
Martin v. Löwis 73d538b9c6 Always initialize Py_FileSystemDefaultEncoding on Unix in Py_Initialize,
and not as a side effect of setlocale. Expose it as sys.getfilesystemencoding.
Adjust test case.
2003-03-05 15:13:47 +00:00
Michael W. Hudson 9c20615d4f Back in June in revision 1.98 Steve (accidentally, presumably) wiped
out a month's worth of checkins to libstdtypes.tex (including my
extended slice docs).

I think this checkin merges them all back in, but if you make one of
these checkins:

    revision 1.97
    date: 2002/06/14 00:27:13;  author: nnorwitz
    Use \code{True} (or False) instead of true/false.
    Not sure if code is correct, but that is what's in this file.
    I've seen \constant{True} in other places.
    ----------------------------
    revision 1.95
    date: 2002/05/22 20:39:43;  author: bwarsaw
    Jack's documentation for the U mode character on the file()
    constructor, vetted by Barry.
    ----------------------------
    revision 1.94
    date: 2002/05/21 18:19:15;  author: rhettinger
    Patch 543387.  Document deprecation of complex %, //,and divmod().
    ----------------------------
    revision 1.93
    date: 2002/05/15 15:45:25;  author: rhettinger
    Added missing index entries for mapping methods.  Closes patch
    #548693.

some checking may be in order.
2003-03-05 14:42:09 +00:00
Andrew M. Kuchling 69700ef573 Weaken recommendation of Friedl book; fix reference 2003-03-04 14:17:05 +00:00
Andrew M. Kuchling 02a0b3b81a [bug #692016] update description of {m,n} modifier; you can omit the lower bound 2003-03-04 14:12:24 +00:00
Andrew M. Kuchling 85f3227a74 [bug #696771] Remove misleading parenthetical aside 2003-03-04 14:07:51 +00:00
Just van Rossum 96b1c903f5 Patch #683592 revisited, after discussions with MvL:
- Implement the behavior as specified in PEP 277, meaning os.listdir()
  will only return unicode strings if it is _called_ with a unicode
  argument.
- And then return only unicode, don't attempt to convert to ASCII.
- Don't switch on Py_FileSystemDefaultEncoding, but simply use the
  default encoding if Py_FileSystemDefaultEncoding is NULL. This means
  os.listdir() can now raise UnicodeDecodeError if the default encoding
  can't represent the directory entry. (This seems better than silcencing
  the error and fall back to a byte string.)
- Attempted to decribe the above in Doc/lib/libos.tex.
- Reworded the Misc/NEWS items to reflect the current situation.

This checkin also fixes bug #696261, which was due to os.listdir() not
using Py_FileSystemDefaultEncoding, like all file system calls are
supposed to.
2003-03-03 17:32:15 +00:00
Michael W. Hudson f008998668 Fix bug
[ 555817 ] Flawed fcntl.ioctl implementation.

with my patch that allows for an array to be mutated when passed
as the buffer argument to ioctl() (details complicated by
backwards compatibility considerations -- read the docs!).
2003-03-03 12:29:42 +00:00