Commit Graph

10526 Commits

Author SHA1 Message Date
Georg Brandl 16a57f6a34 Demote warnings to notices where appropriate, following the goal that as few "red box" warnings
should clutter the docs as possible.  Part 1: stuff that gets merged to Py3k.
2009-04-27 15:29:09 +00:00
Georg Brandl d91f8cf779 Remove ".. warning::" markup that doesnt contain warnings for users, rather todo items. 2009-04-27 15:10:44 +00:00
Georg Brandl e1b79ce17e #5856: fix typo s in traceback example. 2009-04-27 15:09:25 +00:00
Eric Smith f254aab098 Note that the caller is resposible for freeing the result of PyOS_double_to_string. 2009-04-26 10:05:11 +00:00
Georg Brandl 438192540d Move pydoc_topics module to its own subdirectory, so that no generated code is in Lib/. 2009-04-26 09:56:44 +00:00
Georg Brandl 0d478c455b Another file where the versions need to be up to date. 2009-04-26 06:06:53 +00:00
Georg Brandl aa9eb9e163 Remove outdated TODO file. 2009-04-26 06:06:19 +00:00
Georg Brandl 576574f5dd Note that the versions are also in README.txt. 2009-04-26 06:05:58 +00:00
Georg Brandl dbc5b4b66f Update versions in instructions for manual set-up. 2009-04-26 06:05:18 +00:00
Georg Brandl afb0d6ef39 Mostly formatting nits, and "and-ed together" -> "or-ed together" flags. 2009-04-26 06:01:04 +00:00
Eric Smith 068f06568b Issue #5835, deprecate PyOS_ascii_formatd.
If anyone wants to clean up the documentation, feel free. It's my first documentation foray, and it's not that great.

Will port to py3k with a different strategy.
2009-04-25 21:40:15 +00:00
Jeroen Ruigrok van der Werven dfcffd4044 Issue #4129: document int -> Py_ssize_t changes. 2009-04-25 21:16:05 +00:00
Jeroen Ruigrok van der Werven 436f1a2e0d Issue #4129: field changed from int to Py_ssize_t. 2009-04-25 21:02:34 +00:00
Jeroen Ruigrok van der Werven acc73b74b8 Issue #4129: more int -> Py_ssize_t documentation. 2009-04-25 20:58:35 +00:00
Jeroen Ruigrok van der Werven 7b3750c8d8 Issue #4129: more int -> Py_ssize_t documentation. 2009-04-25 20:55:39 +00:00
Jeroen Ruigrok van der Werven 36378711b7 Issue #4129: int -> Py_ssize_t documentation. 2009-04-25 20:50:27 +00:00
Jeroen Ruigrok van der Werven 9594c2c5aa Issue #4129: int -> Py_ssize_t documentation. 2009-04-25 20:44:58 +00:00
Jeroen Ruigrok van der Werven 27d51f1a51 Reformat prior to editing. 2009-04-25 20:43:30 +00:00
Jeroen Ruigrok van der Werven be82d2f16f Issue #4129: int -> Py_ssize_t documentation. 2009-04-25 20:41:40 +00:00
Jeroen Ruigrok van der Werven a4c03abb9e Reformat prior to editing. 2009-04-25 20:40:10 +00:00
Jeroen Ruigrok van der Werven 9e03cee97c Since it's a macro, actually refer to it as such instead of function. 2009-04-25 20:37:39 +00:00
Jeroen Ruigrok van der Werven af15b41547 Issue #4129: Add a versionchanged notice for a few forgotten entries. 2009-04-25 19:54:34 +00:00
Jeroen Ruigrok van der Werven de0fed10c8 Reformat, since I've been busy here anyway. 2009-04-25 19:49:05 +00:00
Jeroen Ruigrok van der Werven 2aa7840f54 Issue #4129: Documentation notes for int -> Py_ssize_t changes. 2009-04-25 19:46:19 +00:00
Jeroen Ruigrok van der Werven 691f5f17ee Issue #4129: More documentation pointers about int -> Py_ssize_t.
Also fix up the documentation for PyObject_GC_Resize(). It seems that since
it first got documented, the documentation was actually for
_PyObject_GC_Resize().
2009-04-25 19:44:55 +00:00
Jeroen Ruigrok van der Werven 3537124058 Reformat prior to editing. 2009-04-25 19:10:52 +00:00
Jeroen Ruigrok van der Werven 1ae8c88030 Since I edited this file, reformat for future edits. 2009-04-25 19:04:15 +00:00
Jeroen Ruigrok van der Werven c2aa7b8a0a Reference to an int type, whereas it's a Py_ssize_t as the synopsis states. 2009-04-25 18:57:32 +00:00
Jeroen Ruigrok van der Werven 28c81e0bb5 Reformat prior to editing. 2009-04-25 18:53:48 +00:00
Jeroen Ruigrok van der Werven 2391918f3e Issue #4129: Document more int -> Py_ssize_t changes. 2009-04-25 18:46:03 +00:00
Jeroen Ruigrok van der Werven 84441cc3d5 Reformat prior to editing. 2009-04-25 18:31:20 +00:00
Jeroen Ruigrok van der Werven 089c5cdd09 Issue #4129: Belatedly document which C API functions had their argument(s) or
return type changed from int or int * to Py_ssize_t or Py_ssize_t * as this
might cause problems on 64-bit platforms.
2009-04-25 17:59:03 +00:00
Georg Brandl 208b00d03f #5841: add deprecation py3k warning and notice in the docs for commands module. 2009-04-25 15:11:29 +00:00
Georg Brandl cf5608df81 #5821: add some capabilities of TarFile's file-like object. 2009-04-25 15:05:04 +00:00
Georg Brandl 64034bbf84 #5834: use "failure" instead of "error" because the two have different meanings in unittest context. 2009-04-25 14:51:31 +00:00
Georg Brandl b581804d69 #3320: fix spelling. 2009-04-25 14:50:25 +00:00
Jeroen Ruigrok van der Werven 6f1d543133 Reformat paragraph. 2009-04-25 14:28:02 +00:00
Jeroen Ruigrok van der Werven 325a997efb The type for ppos has been Py_ssize_t since 2.5, reflect this in the
documentation.
2009-04-25 14:27:00 +00:00
Jeroen Ruigrok van der Werven c42c099436 Reformat prior to editing. 2009-04-25 14:24:30 +00:00
Jeroen Ruigrok van der Werven 140d9d673e Reformat file prior to editing. 2009-04-25 13:58:58 +00:00
Jeroen Ruigrok van der Werven 2dcf46ee2c Rewrite a sentence to be more in line with the rest of the documentation with
regard to person and audience.
2009-04-25 13:07:40 +00:00
Jeroen Ruigrok van der Werven a2dce5a9ee Issue #4239: adjust email examples not to use connect() and terminate with
quit() and not close().
2009-04-25 12:49:10 +00:00
Jeroen Ruigrok van der Werven 162641a24c First attempt to document PyObject_HEAD_INIT and PyVarObject_HEAD_INIT. 2009-04-25 11:59:09 +00:00
Jeroen Ruigrok van der Werven bc25bf9d3e Reformat prior to expanding. 2009-04-25 11:15:06 +00:00
Georg Brandl 508c423fe1 Add link to PEP 236. 2009-04-23 08:52:03 +00:00
Georg Brandl 69923a1df6 #5813: add a reference to the "future statements" section. 2009-04-23 08:49:56 +00:00
Georg Brandl 95089bc9bf Fix rewrapping accident. 2009-04-23 08:49:39 +00:00
Georg Brandl 49cc4eafcb #5820: fix bug in usage of getreader(). 2009-04-23 08:44:57 +00:00
Mark Dickinson 8100bd8431 Issue #5812: make Fraction('1e-6') valid. Backport of r71806. 2009-04-22 18:15:25 +00:00
Nick Coghlan 5533ff6a2e Issue 5354: Change API for import_fresh_module() to better support test_warnings use case (also fixes some bugs in the original implementation) 2009-04-22 15:26:04 +00:00
Eric Smith 4c074382bd Documentation for issue 5237, auto-numbered format fields. Contributed by Terry J. Reedy. 2009-04-22 00:47:00 +00:00
Georg Brandl e56101136c #5751: fix escaping of \\n. 2009-04-21 18:24:34 +00:00
Georg Brandl ce54356690 #5757: fix copy-paste error in notify(). 2009-04-21 18:23:08 +00:00
Raymond Hettinger cccfc825e4 Fix typo 2009-04-20 18:23:57 +00:00
Raymond Hettinger 76162e305c Clarify the behavior of any() and all() with an empty iterable. 2009-04-16 18:16:10 +00:00
R. David Murray 7203081025 Less red ink (warning->note) and add link to def of side-by-side assembly. 2009-04-16 18:12:53 +00:00
R. David Murray 6076d399b4 Fix for issue3440: add warning to subprocess discussion of
env parameter that on Windows SystemRoot is required in order
to run side-by-side assemblies.
2009-04-15 22:33:07 +00:00
Benjamin Peterson 5c9914899b tupel -> tuple 2009-04-14 21:23:09 +00:00
Georg Brandl b48327a215 #5745: more linking for identifiers in email docs. 2009-04-13 13:13:25 +00:00
Georg Brandl 456cb1e694 Simplify markup. 2009-04-13 12:36:18 +00:00
Hirokazu Yamamoto 4585746fb0 Fixed another typos. (email.Utils => email.utils) 2009-04-13 01:21:56 +00:00
Hirokazu Yamamoto 3bd4058d82 Fixed typo. (email.Utils => email.utils) 2009-04-13 01:07:06 +00:00
Benjamin Peterson a9feadc0dd fix missing quote 2009-04-12 23:44:15 +00:00
Benjamin Peterson 7bedd625df fix extra parenthesis #5774 2009-04-12 23:19:56 +00:00
Eric Smith 507690c6e5 Take credit for my patch for issue 5237. 2009-04-12 02:57:29 +00:00
Benjamin Peterson aa0a0b9007 fix markup 2009-04-11 20:27:15 +00:00
Georg Brandl 64e1c75455 Take credit for a patch of mine. 2009-04-11 18:19:27 +00:00
Andrew M. Kuchling b2faddb610 Re-word 2009-04-11 16:18:14 +00:00
Andrew M. Kuchling 2c130b6be7 Add various items 2009-04-11 16:12:23 +00:00
Tarek Ziadé 942825f7de #5732: added the check command into Distutils 2009-04-11 14:55:07 +00:00
Tarek Ziadé b2daff2905 fixed link 2009-04-11 13:59:05 +00:00
Nick Coghlan cd2e7042ae Issue 5354: Provide a standardised testing mechanism for doing fresh imports of modules, including the ability to block extension modules in order to test the pure Python fallbacks 2009-04-11 13:31:31 +00:00
Raymond Hettinger f0f475da61 Add examples. 2009-04-10 13:16:50 +00:00
Georg Brandl 5623e50d1a Let "lambda" point to the correct heading. 2009-04-10 08:16:47 +00:00
Raymond Hettinger c4f4697196 Fix the count of datatypes. 2009-04-10 06:38:39 +00:00
Raymond Hettinger f368fbc24e Clarify the table entries for combinatorics. 2009-04-10 04:25:45 +00:00
Raymond Hettinger 3f5a0b3316 IE needs the border-left:0 for some reason. 2009-04-10 02:01:21 +00:00
Raymond Hettinger 8dbae0ff15 More table clean-up 2009-04-10 00:49:41 +00:00
Raymond Hettinger 80a71a0171 Center table headings. 2009-04-09 23:34:14 +00:00
Raymond Hettinger 390fa983d7 More table formatting. 2009-04-09 23:25:30 +00:00
Raymond Hettinger c473c5aa9b Add note on using keyword arguments with OrderedDict. 2009-04-09 22:31:51 +00:00
Georg Brandl c8c358a489 Add a custom stylesheet with better table formatting. 2009-04-09 19:01:04 +00:00
Andrew M. Kuchling 5963185b23 Typo fixes 2009-04-09 11:23:36 +00:00
Andrew M. Kuchling 24520b4365 Add items 2009-04-09 11:22:47 +00:00
Georg Brandl 1e97cb2b73 Update ignore file for suspicious builder. 2009-04-08 16:39:04 +00:00
Georg Brandl 6cb1ff32c2 Remove redundant backtick. 2009-04-08 16:36:39 +00:00
Raymond Hettinger 085b998a36 Fix make.bat to match makefile changes 2009-04-07 21:43:51 +00:00
Tarek Ziadé 64408fb4c5 Fixed #5095: msi missing from Distutils bdist formats 2009-04-05 22:51:09 +00:00
Michael Foord f2dfef1637 Adding assertIs and assertIsNot methods to unittest.TestCase
Issue #2578
2009-04-05 19:19:28 +00:00
Georg Brandl 1ede0d670f #5298: clarify docs about GIL by using more consistent wording. 2009-04-05 17:17:42 +00:00
Georg Brandl 4af280ee98 #5444: adapt make.bat to new htmlhelp output file name. 2009-04-05 16:30:43 +00:00
Georg Brandl a7ec0726e2 #5370: doc update about unpickling objects with custom __getattr__ etc. methods. 2009-04-05 14:40:06 +00:00
Georg Brandl 5d19610f8d #1718017: document the relation of os.path and the posixpath, ntpath etc. modules better. 2009-04-05 10:41:02 +00:00
Georg Brandl 75f1107b7c Avoid sure signs of a diseased mind. 2009-04-05 10:32:26 +00:00
Georg Brandl 89b1296ab9 Normalize spelling of Mac OS X. 2009-04-05 10:29:57 +00:00
Georg Brandl 9af0c56057 #1742837: expand HTTP server docs, and fix SocketServer ones to document methods as methods, not functions. 2009-04-05 10:24:20 +00:00
Benjamin Peterson f9c8193b76 note how using iter* are unsafe while mutating and document iter(dict) 2009-04-04 23:46:34 +00:00
Georg Brandl 29b36308a4 #5601: clarify that webbrowser is not meant for file names. 2009-04-04 13:45:49 +00:00
Georg Brandl 9d977b81a1 #5642: clarify map() compatibility to the builtin. 2009-04-04 13:42:39 +00:00
R. David Murray 195374e836 Fix error in description of 'oct' (issue 5678). 2009-04-04 06:39:56 +00:00
Raymond Hettinger 64906bbeba Add helpful link. 2009-04-04 05:37:47 +00:00
Vinay Sajip 353a85f99c Clarified warning about logging use from asynchronous signal handlers. 2009-04-03 21:58:16 +00:00
Andrew M. Kuchling a178a69819 Fix 'the the' duplication 2009-04-03 21:45:29 +00:00
Andrew M. Kuchling aa34f5a2ac Fix 'the the'; grammar fix 2009-04-03 21:44:49 +00:00
Andrew M. Kuchling 9a4b94ca0c Add some items 2009-04-03 21:43:00 +00:00
Vinay Sajip b0b1aa214a Added warning about logging use from asynchronous signal handlers. 2009-04-03 10:23:18 +00:00
Raymond Hettinger 6df48a3354 Update docs for namedtuple's renaming change. 2009-04-02 22:34:17 +00:00
Antoine Pitrou 789be0c0a0 Issue #2396: backport the memoryview object. 2009-04-02 21:18:34 +00:00
Jesse Noller 7152f6d915 Add custom initializer argument to multiprocess.Manager*, courtesy of lekma 2009-04-02 05:17:26 +00:00
R. David Murray d56bab47f1 Clarify that datetime strftime does not produce leap seconds and datetime
strptime does not accept it in the strftime behavior section of the
datetime docs.

Closes issue 2568.
2009-04-02 04:34:04 +00:00
Jesse Noller 5053fbbb38 Issue 3551: Raise ValueError if the size causes ERROR_NO_SYSTEM_RESOURCES 2009-04-02 04:22:09 +00:00
Michael Foord 345b2fe21e Better exception messages for unittest assert methods.
- unittest.assertNotEqual() now uses the inequality operator (!=) instead
  of the equality operator.

- Default assertTrue and assertFalse messages are now useful.

- TestCase has a longMessage attribute. This defaults to False, but if set to True
  useful error messages are shown in addition to explicit messages passed to assert methods.

Issue #5663
2009-04-02 03:20:38 +00:00
Brett Cannon c4f90ebea7 PyImport_AppendInittab() took a char * as a first argument even though that
string was stored beyond the life of the call. Changed the signature to be
const char * to help make this point.

Closes issue #1419652.
2009-04-02 03:17:39 +00:00
Benjamin Peterson 7b0f1540ea this should be :noindex: 2009-04-02 00:12:47 +00:00
Benjamin Peterson 02ee8888cd fix markup 2009-04-02 00:11:52 +00:00
Andrew M. Kuchling e9d35ef230 Typo fix 2009-04-02 00:02:14 +00:00
Georg Brandl 88ed8f2c50 #4572: add SEEK_* values as constants in io.py. 2009-04-01 21:00:55 +00:00
Raymond Hettinger fff2f4bb03 Add link to an alternative generator with a long-period. 2009-04-01 20:50:58 +00:00
Jesse Noller b12e79da1b Issue 3270: document Listener address restrictions on windows 2009-04-01 16:42:19 +00:00
Jesse Noller 02cb0eb231 Fix multiprocessing.event to match the new threading.Event API 2009-04-01 03:45:50 +00:00
Josiah Carlson bb94d43dcd Fix for failing asyncore tests. 2009-04-01 01:28:11 +00:00
Georg Brandl a08867d8a1 Dont shout to users. 2009-03-31 23:01:27 +00:00
Raymond Hettinger 6bc94cbbc8 Improve examples for collections.deque() 2009-03-31 22:43:03 +00:00
Georg Brandl 354e4cbb1c #5018: remove confusing paragraph. 2009-03-31 22:40:16 +00:00
Tarek Ziadé 9e47ce49a0 #5583 Added optional Extensions in Distutils 2009-03-31 22:27:23 +00:00
Georg Brandl b7715865e7 #3427: document correct return type for urlopen().info(). 2009-03-31 22:18:19 +00:00
Georg Brandl 95fafec732 #5563: more documentation for bdist_msi. 2009-03-31 22:03:40 +00:00
Georg Brandl a08e8dedc2 #5598: document DocFileSuite *args argument. 2009-03-31 21:15:33 +00:00
Georg Brandl 186188d89d #1530012: move TQS section before raw strings. 2009-03-31 20:56:32 +00:00
Georg Brandl ef660e8e50 #1674032: return value of flag from Event.wait(). OKed by Guido. 2009-03-31 20:41:08 +00:00
Gregory P. Smith 65ff00559a Issue an actual PendingDeprecationWarning for the TestCase.fail* methods.
Document the deprecation.
2009-03-31 19:59:14 +00:00
Georg Brandl bdaa6a7043 #5618: fix typo. 2009-03-31 19:30:56 +00:00
Georg Brandl 956ed9782a #4411: document mro() and __mro__. (I hope I got it right.) 2009-03-31 19:26:24 +00:00
Georg Brandl 2ce1c61ca6 Fix-up unwanted change. 2009-03-31 19:14:42 +00:00
Georg Brandl b48adecbd6 #1096310: document usage of sys.__std*__ a bit better. 2009-03-31 19:10:35 +00:00
Georg Brandl 5206086e0d #4882: document named group behavior a bit better. 2009-03-31 19:06:57 +00:00
Georg Brandl 6eabc24416 #5241: document missing U in regex howto. 2009-03-31 18:38:56 +00:00
Georg Brandl a9efe6f65c #5227: note that Py_Main doesnt return on SystemExit. 2009-03-31 18:33:10 +00:00
Georg Brandl 9e0b363629 #5245: note that PyRun_SimpleString doesnt return on SystemExit. 2009-03-31 18:30:37 +00:00
Georg Brandl 22717dffba #837577: note cryptic return value of spawn*e on invalid env dicts. 2009-03-31 18:26:55 +00:00
Georg Brandl aa118103d7 #970783: document PyObject_Generic[GS]etAttr. 2009-03-31 17:13:06 +00:00
Georg Brandl 268d85d1e8 #992207: document that the parser only accepts \\n newlines. 2009-03-31 16:54:38 +00:00
Gregory P. Smith 2839985c7e The unittest.TestCase.assertEqual() now displays the differences in lists,
tuples, dicts and sets on failure.

Many new handy type and comparison specific assert* methods have been added
that fail with error messages actually useful for debugging.  Contributed in
by Google and completed with help from mfoord and GvR at PyCon 2009 sprints.

Discussion lives in http://bugs.python.org/issue2578.
2009-03-31 16:54:10 +00:00
Georg Brandl c2784229b8 #5417: replace references to undocumented functions by ones to documented functions. 2009-03-31 16:50:25 +00:00
Georg Brandl b945bbf33e #1386675: specify WindowsError as the exception, because it has a winerror attribute that EnvironmentError doesnt have. 2009-03-31 16:31:11 +00:00
Georg Brandl 624f3372e2 #5529: backport new docs of import semantics written by Brett to 2.x. 2009-03-31 16:11:45 +00:00
Georg Brandl 21b60afd4c #5581: fget argument of abstractproperty is optional as well. 2009-03-31 15:50:16 +00:00
Georg Brandl 74c018a981 #5566: fix versionadded from PyLong ssize_t functions. 2009-03-31 15:46:30 +00:00
Georg Brandl 382edff289 #5519: remove reference to Kodos, which seems dead. 2009-03-31 15:43:20 +00:00
Andrew M. Kuchling 7706957f59 Add various items 2009-03-31 01:21:01 +00:00
Andrew M. Kuchling 6c2633e919 Add more items 2009-03-30 23:09:46 +00:00
Andrew M. Kuchling efa97718e6 typo fix 2009-03-30 23:08:24 +00:00
Georg Brandl dc340eedaa #5039: make it clear that the impl. note refers to CPython. 2009-03-30 22:43:00 +00:00
Barry Warsaw dbf95a3643 A fix for issue 1974, inspired by the patch from Andi Albrecht (aalbrecht),
though with some changes by me.  This patch should not be back ported or
forward ported.  It's a bit too risky for 2.6 and 3.x does things fairly
differently.
2009-03-30 22:42:17 +00:00
Andrew M. Kuchling 55acfc6c87 Many edits 2009-03-30 22:31:11 +00:00
Andrew M. Kuchling 71d5c28d97 Add several items and placeholders 2009-03-30 22:30:20 +00:00
Andrew M. Kuchling b585255f02 Remove comment 2009-03-30 22:29:53 +00:00
Andrew M. Kuchling 19672006a7 Typo fixes 2009-03-30 22:29:15 +00:00
Georg Brandl d59efbccf1 #5199: make warning about vars() assignment more visible. 2009-03-30 22:09:34 +00:00
Ronald Oussoren 008af85dc0 Fix for issue 13095 2009-03-30 20:02:08 +00:00
Ronald Oussoren 8ba6f3baf6 Fix for issue 896199 (some Carbon modules aren't present in the documentation) 2009-03-30 16:01:51 +00:00
Benjamin Peterson ac0580edc2 there's actually three methods here #5600 2009-03-30 02:49:32 +00:00
Benjamin Peterson c5206b3893 use the awesome new status iterator 2009-03-29 21:50:14 +00:00
Mark Dickinson 2e648ecc7d Issue #532631: Replace confusing fabs(x)/1e25 >= 1e25 test
with fabs(x) >= 1e50, and fix documentation.
2009-03-29 14:37:51 +00:00
Benjamin Peterson 097aafdde6 fix consistency 2009-03-29 03:39:58 +00:00
Benjamin Peterson 7233acc5c5 stop the versionchanged directive from hiding the docs 2009-03-29 03:31:40 +00:00
Benjamin Peterson be76d4caed a more realistic example 2009-03-29 03:16:57 +00:00
Georg Brandl a0eea590c7 Add section numbering to some of the larger subdocuments. 2009-03-28 19:57:36 +00:00
Georg Brandl 400fd60a8d Switch to fixed Sphinx version. 2009-03-28 19:52:58 +00:00
Antoine Pitrou b22b94886d Fix a typo and be more specific 2009-03-28 19:17:54 +00:00
Benjamin Peterson 0e9285845e give os.symlink and os.link() better parameter names #5564 2009-03-28 19:16:10 +00:00
Georg Brandl a31aa45fbf #5324: document __subclasses__(). 2009-03-28 19:10:37 +00:00
Antoine Pitrou c18f6b023d Publicize the GC untracking optimization 2009-03-28 19:10:13 +00:00
Benjamin Peterson 47d9738b0f rename TestCase.skip() to skipTest() because it causes annoying problems with trial #5571 2009-03-26 20:05:50 +00:00
Skip Montanaro 9a1337b95e clarify the type of data returned 2009-03-25 00:52:11 +00:00
Raymond Hettinger 21b617bd98 Add links to related resources. 2009-03-24 00:17:11 +00:00
Benjamin Peterson 31b7806ee8 forgot to document that setUp can be skipped (silly me...) 2009-03-23 23:13:36 +00:00
Benjamin Peterson 99721e0c44 refactor unittest docs 2009-03-23 23:10:14 +00:00
Benjamin Peterson cb2b0e45d4 comply with the evilJavaNamingScheme for attribute names
It seems my love of PEP 8 overrode the need for consistentcy
2009-03-23 22:29:45 +00:00
Benjamin Peterson 692428e77f implement test skipping and expected failures
patch by myself #1034053
2009-03-23 21:50:21 +00:00
Antoine Pitrou f8387af262 Issue #4688: Add a heuristic so that tuples and dicts containing only
untrackable objects are not tracked by the garbage collector. This can
reduce the size of collections and therefore the garbage collection overhead
on long-running programs, depending on their particular use of datatypes.

(trivia: this makes the "binary_trees" benchmark from the Computer Language
Shootout 40% faster)
2009-03-23 18:41:45 +00:00
Raymond Hettinger 2cef1a5409 Add MutableSet example. 2009-03-20 18:25:49 +00:00
Mark Dickinson efc82f7e8e Issue #4258: Use 30-bit digits for Python longs, on 64-bit platforms.
Backport of r70459.
2009-03-20 15:51:55 +00:00
Raymond Hettinger 2412299be9 * Add clearer comment to initialization code.
* Add optional argument to popitem() -- modeled
  after Anthon van der Neut's C version.
* Fix method markup in docs.
2009-03-19 19:59:58 +00:00
Raymond Hettinger 91852ca673 Issue 5381: Add object_pairs_hook to the json module. 2009-03-19 19:19:03 +00:00
Benjamin Peterson 06919a177d a much better example 2009-03-18 20:58:09 +00:00
Benjamin Peterson ed3558b334 I thought this was begging for an example 2009-03-17 20:29:51 +00:00
Georg Brandl 8cbe9556cf Add token markup. 2009-03-16 19:42:03 +00:00
Georg Brandl 545a134916 Fix markup in re docs and give a mail address in regex howto, so that
the recommendation to send suggestions to the author can be followed.
2009-03-15 21:59:37 +00:00
Georg Brandl 173c1f1a01 #5469: add with statement to list of name-binding constructs. 2009-03-15 21:53:56 +00:00
Georg Brandl 09827eb55e #5276: document IDLESTARTUP and .Idle.py. 2009-03-15 21:51:48 +00:00
Georg Brandl 8db96b5969 #5478: fix copy-paste oversight in function signature. 2009-03-15 21:47:42 +00:00
Georg Brandl 44e5cd3e51 #5488: add missing struct member. 2009-03-15 21:46:00 +00:00
Georg Brandl 5a95b21fee #5491: clarify nested() semantics. 2009-03-15 21:44:43 +00:00
Georg Brandl 3259ef3dff #5493: clarify __nonzero__ docs. 2009-03-15 21:37:16 +00:00
Georg Brandl e83a4adba7 #5486: typos. 2009-03-13 19:03:58 +00:00
Raymond Hettinger efa7c138b6 Issue 5477: Fix buglet in the itertools documentation. 2009-03-12 00:31:58 +00:00
Raymond Hettinger 351de8017c Add reference to solution for a commonly asked question. 2009-03-12 00:25:03 +00:00
Brett Cannon 6c4cff0f32 Require implementations for warnings.showwarning() support the 'line' argument.
Was a DeprecationWarning for not supporting it since Python 2.6.

Closes issue #3652.
2009-03-11 04:51:06 +00:00
Raymond Hettinger 8f19598f78 Fix typo. 2009-03-10 13:04:30 +00:00
Raymond Hettinger 56411aac79 For collections.deque() objects, expose the maxlen parameter as a read-only attribute. 2009-03-10 12:50:59 +00:00
Raymond Hettinger ced6b1da83 Update the decimal FAQ for the from_float() classmethod and improve the recipe for remove_exponent() to make it cut and pasteable. 2009-03-10 08:16:05 +00:00
Raymond Hettinger eecd1dc6e0 Clarify the meaning of normal and subnormal. 2009-03-10 04:40:24 +00:00
Raymond Hettinger f345a21d8e Update url for the spec. 2009-03-10 01:07:30 +00:00
Raymond Hettinger f4ea929044 Fix markup. 2009-03-10 00:06:05 +00:00
Benjamin Peterson 6d83429a1d gzip and bz2 are context managers 2009-03-09 20:38:56 +00:00
Georg Brandl 38f1bf6745 Add missing space. 2009-03-09 16:35:48 +00:00
Georg Brandl 2cd82a8383 #5458: add a note when we started to raise RuntimeErrors. 2009-03-09 14:25:07 +00:00
Raymond Hettinger 9324ed8982 Add cross-reference to the collections docs. 2009-03-09 12:56:23 +00:00
Raymond Hettinger 3496a89f27 Add consume() recipe to itertools docs. 2009-03-09 11:57:29 +00:00
Raymond Hettinger fed84c765d Issue 5443: Fix typo. 2009-03-09 11:31:39 +00:00
Jesus Cea ce15a65ca7 Minor bsddb documentation glitch 2009-03-05 19:37:37 +00:00
Benjamin Peterson c51ec0a9e3 add example 2009-03-05 00:17:57 +00:00
Facundo Batista eeafb96b08 Fixed a typo. 2009-03-04 21:18:17 +00:00
Georg Brandl d5ad6da03b Remove obsolete stuff from string module docs. 2009-03-04 18:24:41 +00:00
Benjamin Peterson 288618e1a7 making the writing more formal 2009-03-03 22:51:57 +00:00
Raymond Hettinger a07038d614 Fix markup. 2009-03-03 05:11:56 +00:00
Raymond Hettinger e89b8e9832 Backport 70111: Let configparser use ordered dicts by default. 2009-03-03 05:00:37 +00:00
Raymond Hettinger 88a9164cdb Backport 70106: Add OrderedDict support to collections.namedtuple(). 2009-03-03 04:51:24 +00:00
Raymond Hettinger bc512d3abd Backport PEP 372: OrderedDict() 2009-03-03 04:45:34 +00:00
Gregory P. Smith ae91d0907d Adds an optional flags argument to re.split, re.sub and re.subn to be
consistent with the other re module functions.
2009-03-02 05:13:57 +00:00
Gregory P. Smith 0261e5d0b6 The note about caching of regular expression objects was incorrect ReST and
thus invisible in the compiled documentation.  Fixed.  Also I cleaned up the
wording.
2009-03-02 04:53:24 +00:00
Raymond Hettinger 3bac8b20b5 Fix docs for ConfigParser. 2009-03-01 02:04:32 +00:00
Jeffrey Yasskin 68d6852006 Backport r69961 to trunk, replacing JUMP_IF_{TRUE,FALSE} with
POP_JUMP_IF_{TRUE,FALSE} and JUMP_IF_{TRUE,FALSE}_OR_POP. This avoids executing
a POP_TOP on each conditional and sometimes allows the peephole optimizer to
skip a JUMP_ABSOLUTE entirely. It speeds up list comprehensions significantly.
2009-02-28 19:03:21 +00:00
Hirokazu Yamamoto 02172ddbee Binary flag is needed on windows. 2009-02-28 15:24:00 +00:00
Georg Brandl 5c189b16a8 #5365: add quick look conversion table for different time representations. 2009-02-27 16:59:03 +00:00
Georg Brandl fbb995f6c2 #5344: fix punctuation. 2009-02-27 16:52:55 +00:00
Georg Brandl ee6361f7d8 #5363: fix cmpfiles() docs. Another instance where a prose description is twice as long as the code. 2009-02-27 16:39:26 +00:00
Georg Brandl da2790c47d #5361: fix typo. 2009-02-27 16:23:18 +00:00
Tarek Ziadé 75a4fab6a4 more info on long_description 2009-02-27 02:14:35 +00:00
Andrew M. Kuchling cdb4e6248b The curses panel library is now supported 2009-02-26 22:34:30 +00:00
Georg Brandl 13813f7092 Document that setting sys.py3kwarning wont do anything. 2009-02-26 17:36:26 +00:00
Benjamin Peterson a168698ab3 fix str.format()'s first arg #5371 2009-02-26 00:30:11 +00:00
Raymond Hettinger ed955f108f Fix typo. 2009-02-26 00:05:24 +00:00
Raymond Hettinger a665853bab Clarify Counter() docs. 2009-02-25 22:48:24 +00:00
Raymond Hettinger afe496dc46 Remove reference to zero argument form of super() in 2.x docs. 2009-02-25 01:06:52 +00:00
Raymond Hettinger b762d58544 More markup and spelling fixes. 2009-02-25 00:52:37 +00:00
Raymond Hettinger eb7cbb94c5 Restore Py2.x version of sample call to super(). 2009-02-25 00:39:47 +00:00
Raymond Hettinger 9766033b7c Sync-up py3.1 doc updates for super(). 2009-02-25 00:37:57 +00:00
Raymond Hettinger d47442e3cb Update itertools recipes to use next(). 2009-02-23 19:32:55 +00:00
Georg Brandl 52bc7b85fd Fix grammar. 2009-02-23 18:33:48 +00:00
Georg Brandl de196911f1 #5352: str.count() counts non-overlapping instances. 2009-02-23 15:51:27 +00:00
Georg Brandl 89d4f0d7c5 #5349: C++ pure virtuals can also have an implementation. 2009-02-23 11:24:46 +00:00
Georg Brandl 528f8810aa #5348: format() converts all kinds of values. 2009-02-23 10:24:23 +00:00
Tarek Ziadé 2595edccbc using versionchanged instead of versionadded for distutils doc on sdist default files 2009-02-22 00:07:45 +00:00
Mark Dickinson 3e4caeb3bf Issue #5341: Fix a variety of spelling errors. 2009-02-21 20:27:01 +00:00
Georg Brandl a12a86e956 #5338, #5339: two types in the API manual. 2009-02-21 19:09:40 +00:00
Georg Brandl 8b8c2df9b1 Fix punctuation. 2009-02-20 08:45:47 +00:00
Georg Brandl 6b5dbaa6c9 At least separate imports from other statements. 2009-02-20 08:22:21 +00:00
Georg Brandl 4a698721e6 #5327: fix a broken link by joining it. 2009-02-20 07:48:21 +00:00
Benjamin Peterson a7b55a33f8 revert r69777 since all the experts agree that extra import lines distract from the code 2009-02-20 03:31:23 +00:00
Jeroen Ruigrok van der Werven 5149742e8b Since we recommend one module per import line, reflect this also in the
documentation.
2009-02-19 18:52:21 +00:00
Georg Brandl a630735b31 #5317: update IronPython URL. 2009-02-19 16:34:51 +00:00
Georg Brandl e7cb1ce895 #5310, #3558: fix operator precedence table. 2009-02-19 08:30:06 +00:00
Raymond Hettinger 749e6d0a01 Add links to helpful external resources. 2009-02-19 06:55:03 +00:00
Raymond Hettinger 7d854955e1 Add an example for math.fsum() and elaborate on the accurary note. 2009-02-19 05:51:41 +00:00
Raymond Hettinger f9bce83e71 Add some cross-references to the docs. Simplify the python code equivalent for izip(). Supply an optional argument for the nth() recipe. 2009-02-19 05:34:35 +00:00
Raymond Hettinger c8223b09b0 Generalize the itertools.tee() recipe. 2009-02-18 20:54:53 +00:00
Gregory P. Smith 8367becc02 Clarify socket timeout behavior vs system network stack behavior on connect
for issue5293.
2009-02-18 05:46:11 +00:00
Georg Brandl 580d7c1f57 #5268: mention VMSError. 2009-02-18 00:31:36 +00:00
Georg Brandl 0ac63f1c50 #5296: sequence -> iterable. 2009-02-18 00:25:13 +00:00
Georg Brandl 52f6b6d500 #5297: fix example. 2009-02-18 00:22:55 +00:00
Marc-André Lemburg 1d0b5cc6dc Clarify the deprecation of platform.dist().
Add versionadded tags.
2009-02-17 12:48:19 +00:00
Raymond Hettinger 0aee942a08 Fixup intro paragraphs for the itertools docs. Add some tables for quick reference. 2009-02-17 11:00:27 +00:00
Raymond Hettinger f746a1f1e4 Fix-up intro paragraph for collections docs. 2009-02-17 08:33:01 +00:00
Raymond Hettinger 7c98a6d4dc Add explanation for super(type1, type2). 2009-02-16 23:00:25 +00:00
Raymond Hettinger fd04870a3d Issue 5229: Documentation for super() neglects to say what super() actually does 2009-02-16 22:42:54 +00:00
Tarek Ziadé f1c95fe004 note about #2279 2009-02-16 22:38:43 +00:00
Tarek Ziadé 7dd533963f Fixed #2279: distutils.sdist.add_defaults now add files listed in package_data and data_files 2009-02-16 21:38:01 +00:00
Benjamin Peterson afb5a48be2 note functions that are not aliased to PyBytes_ #5280 2009-02-16 14:54:34 +00:00
Hirokazu Yamamoto 5b8c701eef Fixed typo. 2009-02-15 09:19:48 +00:00
Raymond Hettinger a4038038c6 Add keyword argument support to itertools.count(). 2009-02-14 00:25:51 +00:00
Georg Brandl 5ccf2ae21c #1661108: note that urlsafe encoded string can contain "=". 2009-02-13 10:56:50 +00:00
Georg Brandl 9834dd72bc #3734: document complex coercing behavior better. 2009-02-13 10:44:17 +00:00
Georg Brandl 8fba5b337c #4894: document "newurl" parameter to redirect_request(). 2009-02-13 10:40:14 +00:00
Tarek Ziadé e6aeba7444 #5158: added documentation on the depends option in distutils extensions 2009-02-13 09:12:33 +00:00
Georg Brandl 5b2cb1d56e Add links to the other versions we have in stock. 2009-02-13 09:08:34 +00:00
Raymond Hettinger 31c769ca89 Issue 5032: added a step argument to itertools.count() and allowed non-integer arguments. 2009-02-12 05:39:46 +00:00
Benjamin Peterson 1312b4bcfd os.fsync() should be used to ensure that data is written to disk 2009-02-12 03:50:00 +00:00
Raymond Hettinger e4ae63c402 Clean-up named tuple docs. 2009-02-11 00:06:17 +00:00
Mark Dickinson 4015f62e39 Issue #5175: PyLong_AsUnsignedLongLong now raises OverflowError for
negative arguments.  Previously, it raised TypeError.

Thanks Lisandro Dalcin.
2009-02-10 15:46:50 +00:00
Raymond Hettinger 322daea7c3 Issue 1818: collections.namedtuple() to support automatic renaming of invalid fieldnames. 2009-02-10 01:24:05 +00:00
Benjamin Peterson b8e17f7370 a few edits and typos 2009-02-08 15:14:57 +00:00
Benjamin Peterson c5e68b1898 document numliterals fixer 2009-02-08 14:38:13 +00:00
Nick Coghlan 0194f5bc98 Issue #4512 closeout: Make ZipImport.get_filename() a public method 2009-02-08 03:17:00 +00:00
Nick Coghlan d39600e69f Issue 4195: Restore the ability to execute packages with the -m switch (but this time in a way that leaves the import machinery in a valid state). (Original patch by Andi Vajda) 2009-02-08 01:26:34 +00:00
Benjamin Peterson e0820e2ea7 document individual 2to3 fixers 2009-02-07 23:01:19 +00:00
Georg Brandl 95f8ef2825 make "super only for new-style classes" a note. 2009-02-07 18:49:54 +00:00
Georg Brandl 34feea3205 #5174: fix wrong file closing in example. 2009-02-07 12:21:17 +00:00
Benjamin Peterson a96a94af50 fix download link 2009-02-06 01:47:31 +00:00
Eric Smith 81fe09344c Implement issue #4285, convert sys.version_info to a named
tuple. Patch by Ross Light.
2009-02-06 00:48:26 +00:00
Georg Brandl ecd2afa452 #5031: fix Thread.daemon property docs. 2009-02-05 11:40:35 +00:00
Georg Brandl 85c5ccfab9 #4563: disable alpha and roman lists, fixes wrong formatting of contributor list. 2009-02-05 11:38:23 +00:00
Georg Brandl 2b0dd8e199 #4820: use correct module for ctypes.util. 2009-02-05 11:35:28 +00:00
Georg Brandl 253a29fa4d #4827: fix callback example. 2009-02-05 11:33:21 +00:00
Georg Brandl 4400d84bf7 #5015: document PythonHome API functions. 2009-02-05 11:32:18 +00:00
Georg Brandl 3ceebd2ca7 PyErr_PrintEx is also in 2.x... 2009-02-05 11:23:47 +00:00
Georg Brandl b21c75beab #5059: fix example. 2009-02-05 10:59:28 +00:00
Georg Brandl acc802b171 #5144: document that PySys_SetArgv prepends the script directory (or the empty string) to sys.path. 2009-02-05 10:37:07 +00:00
Georg Brandl 174fbe7742 #5153: fix typo in example. 2009-02-05 10:30:57 +00:00
Raymond Hettinger aff711d32a Clarify that named tuples do not have to subclass tuple. 2009-02-04 19:25:17 +00:00
Raymond Hettinger 939a3cc5a2 Tweak the docs for Counter() objects. 2009-02-04 11:31:30 +00:00
Raymond Hettinger 8184f5a46c Doc fixes. Remove overbroad, redundant warnings. Fixup example code. 2009-02-04 11:14:18 +00:00
Raymond Hettinger d507afdc81 Minor doc fixups. 2009-02-04 10:52:32 +00:00
Raymond Hettinger 4a1b62a555 Record operator deprecations in docs. 2009-02-03 03:18:14 +00:00
Gregory P. Smith 86cc5029dc wording for for issue4903. 2009-02-01 00:24:21 +00:00
Gregory P. Smith 5501d65590 Update doc wording as suggested in issue4903. 2009-02-01 00:16:01 +00:00
David Goodger a528dc507c markup fix 2009-01-31 22:53:46 +00:00
Benjamin Peterson 4829136965 fix indentation 2009-01-31 20:01:48 +00:00
Benjamin Peterson 0ef803ff0f PyErr_BadInternalCall() raises a SystemError, not TypeError #5112 2009-01-31 16:52:03 +00:00
Andrew M. Kuchling 8c2f85c43e Text edits and markup fixes 2009-01-31 03:26:02 +00:00
Andrew M. Kuchling a17cd4a574 Add a section 2009-01-31 02:50:09 +00:00
Benjamin Peterson 6c8321883e fix download url 2009-01-29 03:03:00 +00:00
Brett Cannon 8aa2c6ce8e Minor spelling mistake in datetime docs. 2009-01-29 00:54:32 +00:00
Brett Cannon 5b0d5531f2 Clarify some __del__ stuff. 2009-01-29 00:54:11 +00:00
Raymond Hettinger 1712baa852 Correct docs for ABCs (MutableSequence was missing __setiem). Simplify the table by taking out inherited requirements for abstract methods. 2009-01-28 23:58:16 +00:00
Guilherme Polo cda93aafde Added the ttk module. See issue #2983: Ttk support for Tkinter. 2009-01-28 13:09:03 +00:00
Raymond Hettinger d081abc8be Promote combinations_with_replacement() from a recipe to a regular itertool. 2009-01-27 02:58:49 +00:00
Raymond Hettinger 22bfa9e3e8 Tweak column alignment for collections docs. 2009-01-27 02:36:33 +00:00
Georg Brandl 0c2430beda Copy over docs on advanced role features from Sphinx docs. 2009-01-26 21:29:38 +00:00
Brett Cannon 93881c6c58 Backport importlib in the form of providing importlib.import_module(). This has
been done purely to help transitions from 2.7 to 3.1.
2009-01-26 01:16:50 +00:00
Raymond Hettinger 68d919e4d6 Improved itertools recipe for generating powerset(). 2009-01-25 21:31:47 +00:00
Raymond Hettinger 2bcb8e9b0d Promote compress() from a recipe to being a regular itertool. 2009-01-25 21:04:14 +00:00
Tarek Ziadé 1af3b5a9a4 Issue #4863, removing remaining bits 2009-01-25 19:29:10 +00:00
Jesse Noller b5a4b0abed Properly document multiprocessing's logging support, resolve outstanding issues with the custom levels 2009-01-25 03:36:13 +00:00
Andrew M. Kuchling 466bd9d3af Add various items 2009-01-24 03:28:18 +00:00
Jesse Noller 403c6632e6 Issue 4593: apply() documentation is unclear 2009-01-22 21:53:22 +00:00
Georg Brandl 40e8415509 Clarify wording. 2009-01-22 18:29:28 +00:00
Raymond Hettinger 7bdca05a3b More doc tweaks. 2009-01-22 05:20:47 +00:00
Raymond Hettinger 0a1f7b8f72 Tighten-up the docs for Counter(). 2009-01-21 23:12:51 +00:00
Raymond Hettinger 4571f347f9 Simplify explanation of multiset operations by removing restrictions on negative inputs. 2009-01-21 20:31:50 +00:00
Andrew M. Kuchling 42ffbdb903 Markup fixes 2009-01-21 02:16:26 +00:00
Andrew M. Kuchling 9cb4277c60 Add some items 2009-01-21 02:15:43 +00:00
Raymond Hettinger acdc84abcf Beautify and cleanup the references section. 2009-01-20 23:42:54 +00:00
Raymond Hettinger 196a0f7a8a Fix typos. 2009-01-20 12:59:36 +00:00
Raymond Hettinger 230dd27628 Don't disrupt automatic url target name generation
with manually specified, conflicting names.

Before:
    http://docs.python.org/dev/library/collections.html#id1

After:
    http://docs.python.org/dev/library/collections.html#counter-objects
2009-01-20 07:11:47 +00:00
Raymond Hettinger bad1eb2ff3 Build-outs for Counter() class:
* Constructor and update() support keyword args (like their dict counterparts).
* The 'del' statement no longer raises KeyError for missing values.
* Add multiset operations:  __add__, __sub__, __and__, __or__.
2009-01-20 01:19:26 +00:00
Benjamin Peterson c84ebe73a7 add email address 2009-01-19 16:18:27 +00:00
Benjamin Peterson b6c7beb722 move BufferedIOBase into the base class section 2009-01-19 16:17:54 +00:00
Vinay Sajip 4b78233cbd Added more cross-reference targets and tidied up list of useful handlers. 2009-01-19 06:49:19 +00:00
Georg Brandl fe11f4d524 #4986: augassigns are not expressions. 2009-01-18 18:25:30 +00:00
Georg Brandl af9a97b245 #4923: clarify what was added. 2009-01-18 14:41:52 +00:00
Georg Brandl 4a565cc41d #4857: fix augmented assignment target spec. 2009-01-18 13:47:26 +00:00
Georg Brandl 9f7fb849df #4979: correct result range for some random functions. 2009-01-18 13:24:10 +00:00
Georg Brandl bb550c99cb #4914: trunc is in math. 2009-01-18 10:48:16 +00:00
Georg Brandl 79f722da6c #4974: fix redundant mention of lists and tuples. 2009-01-18 10:45:22 +00:00
Georg Brandl 6c81b54cc4 #4976: union() and intersection() take multiple args, but talk about "the other". 2009-01-18 10:42:35 +00:00
Jesse Noller 6ab22154dd Resolve issue 4449: AssertionError in mp_benchmarks.py 2009-01-18 02:45:38 +00:00
Benjamin Peterson b746448f46 fix grammar 2009-01-18 01:28:46 +00:00
Benjamin Peterson f1a4069481 bytearrays are mutable sequences 2009-01-18 01:28:09 +00:00