61 Commits

Author	SHA1	Message	Date
Georg Brandl	6b4c847c4f	Doc: fix default role usage (except in unittest mock docs)	2014-10-30 22:26:26 +01:00
Berker Peksag	9c1dba2758	Revert #22251	2014-09-28 00:00:58 +03:00
Berker Peksag	3749404ba5	Issue #22251: Fix ReST markup to avoid errors building docs.	2014-09-27 23:21:35 +03:00
Antoine Pitrou	b6457249bf	Fix the description of pickle protocol numbers	2014-01-21 02:39:54 +01:00
Alexandre Vassalotti	d05c9ff845	Issue #6784: Strings from Python 2 can now be unpickled as bytes objects. ... Initial patch by Merlijn van Deen. I've added a few unrelated docstring fixes in the patch while I was at it, which makes the documentation for pickle a bit more consistent.	2013-12-07 01:09:27 -08:00
Antoine Pitrou	9bcb1127f1	Mention pickle protocol 4, and some tweaks.	2013-12-07 01:05:57 +01:00
Antoine Pitrou	9858e8b98d	Issue #19900: improve generalities at the start of the pickle module doc	2013-12-07 00:57:44 +01:00
Antoine Pitrou	d4d60554bc	Issue #19900: improve generalities at the start of the pickle module doc	2013-12-07 00:56:59 +01:00
Serhiy Storchaka	0e90e99188	Issue #19795: Improved markup of True/False constants.	2013-11-29 12:19:53 +02:00
Serhiy Storchaka	fbc1c26803	Issue #19795: Improved markup of True/False constants.	2013-11-29 12:17:13 +02:00
Antoine Pitrou	c9dc4a2a8a	Issue #17810: Implement PEP 3154, pickle protocol 4. ... Most of the work is by Alexandre.	2013-11-23 18:59:12 +01:00
Andrew Kuchling	587e970be6	Update e-mail address	2013-11-12 10:02:35 -05:00
Andrew Kuchling	7150787b7e	Merge from 3.3	2013-11-12 10:03:20 -05:00
Ethan Furman	2498d9e968	Issue #19272: slight clarification of pickle docs with regard to lambda.	2013-10-18 00:45:40 -07:00
Serhiy Storchaka	5bbbc94073	Issue #19189: Improved cross-references in the pickle module documentation.	2013-10-14 10:43:46 +03:00
Eli Bendersky	a6d0dd5dc3	Fix method name in documentation (__setstate__ --> __getstate__)	2013-01-02 05:54:36 -08:00
Eli Bendersky	78f3ce577f	Fix method name in documentation (__setstate__ --> __getstate__)	2013-01-02 05:53:59 -08:00
Antoine Pitrou	fda08b0860	Some nits in the pickle docs.	2012-05-10 15:38:47 +02:00
Antoine Pitrou	a9494f6c53	Some nits in the pickle docs.	2012-05-10 15:38:30 +02:00
Antoine Pitrou	8d3c290de4	Issue #14166: Pickler objects now have an optional `dispatch_table` attribute which allows to set custom per-pickler reduction functions. ... Patch by sbt.	2012-03-04 18:31:48 +01:00
Ezio Melotti	e62aad3073	#13426: fix typos in pickle doc.	2011-11-18 13:51:10 +02:00
Georg Brandl	5aa580f279	Fix typo.	2010-11-30 14:57:54 +00:00
Georg Brandl	c8148265dc	Port changes to pickle docs apparently lost in py3k.	2010-10-17 11:13:37 +00:00
Georg Brandl	0036bcf8d8	#9105: move pickle warning to a bit more prominent location.	2010-10-17 10:24:54 +00:00
Georg Brandl	6faee4e2ce	#9911: doc copyedits.	2010-09-21 14:48:28 +00:00
Antoine Pitrou	11cb961b38	Add cross-references to the glossary entry for file objects.	2010-09-15 11:11:28 +00:00
Georg Brandl	1824415470	Switch more function arguments docs to new-style.	2009-09-02 20:34:52 +00:00
Antoine Pitrou	d9dfaa9487	Issue #6137: The pickle module now translates module names when loading ... or dumping pickles with a 2.x-compatible protocol, in order to make data sharing and migration easier. This behaviour can be disabled using the new `fix_imports` optional argument.	2009-06-04 20:32:06 +00:00
Georg Brandl	e720c0aa74	Merged revisions 72009 via svnmerge from ... svn+ssh://pythondev@svn.python.org/python/trunk ........ r72009 | georg.brandl | 2009-04-27 17:29:09 +0200 (Mo, 27 Apr 2009) | 3 lines 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 16:20:50 +00:00
Benjamin Peterson	d23f8224e9	Merged revisions 70712,70714,70764-70765,70769-70771,70773,70776-70777,70788-70789,70824,70828,70832,70836,70842,70851,70855,70857,70866-70872,70883,70885,70893-70894,70896-70897,70903,70905-70907,70915,70927,70933,70951,70960,70962-70964,70998,71001,71006,71008,71010-71011,71019,71037,71056,71094,71101-71103,71106,71119,71123,71149-71150,71203,71212,71214-71217,71221,71240 via svnmerge from ... svn+ssh://pythondev@svn.python.org/python/trunk ........ r70712 | benjamin.peterson | 2009-03-30 10:15:38 -0500 (Mon, 30 Mar 2009) | 1 line don't rely on the order dict repr #5605 ........ r70714 | brett.cannon | 2009-03-30 10:20:53 -0500 (Mon, 30 Mar 2009) | 1 line Add an entry to developers.txt. ........ r70764 | martin.v.loewis | 2009-03-30 17:06:33 -0500 (Mon, 30 Mar 2009) | 2 lines Add several VM developers. ........ r70765 | georg.brandl | 2009-03-30 17:09:34 -0500 (Mon, 30 Mar 2009) | 1 line #5199: make warning about vars() assignment more visible. ........ r70769 | andrew.kuchling | 2009-03-30 17:29:53 -0500 (Mon, 30 Mar 2009) | 1 line Remove comment ........ r70770 | andrew.kuchling | 2009-03-30 17:30:20 -0500 (Mon, 30 Mar 2009) | 1 line Add several items and placeholders ........ r70771 | andrew.kuchling | 2009-03-30 17:31:11 -0500 (Mon, 30 Mar 2009) | 1 line Many edits ........ r70773 | georg.brandl | 2009-03-30 17:43:00 -0500 (Mon, 30 Mar 2009) | 1 line #5039: make it clear that the impl. note refers to CPython. ........ r70776 | andrew.kuchling | 2009-03-30 18:08:24 -0500 (Mon, 30 Mar 2009) | 1 line typo fix ........ r70777 | andrew.kuchling | 2009-03-30 18:09:46 -0500 (Mon, 30 Mar 2009) | 1 line Add more items ........ r70788 | andrew.kuchling | 2009-03-30 20:21:01 -0500 (Mon, 30 Mar 2009) | 1 line Add various items ........ r70789 | georg.brandl | 2009-03-30 20:25:15 -0500 (Mon, 30 Mar 2009) | 1 line Fix a wrong struct field assignment (docstring as closure). ........ r70824 | georg.brandl | 2009-03-31 10:43:20 -0500 (Tue, 31 Mar 2009) | 1 line #5519: remove reference to Kodos, which seems dead. ........ r70828 | georg.brandl | 2009-03-31 10:50:16 -0500 (Tue, 31 Mar 2009) | 1 line #5581: fget argument of abstractproperty is optional as well. ........ r70832 | georg.brandl | 2009-03-31 11:31:11 -0500 (Tue, 31 Mar 2009) | 1 line #1386675: specify WindowsError as the exception, because it has a winerror attribute that EnvironmentError doesnt have. ........ r70836 | georg.brandl | 2009-03-31 11:50:25 -0500 (Tue, 31 Mar 2009) | 1 line #5417: replace references to undocumented functions by ones to documented functions. ........ r70842 | georg.brandl | 2009-03-31 12:13:06 -0500 (Tue, 31 Mar 2009) | 1 line #970783: document PyObject_Generic[GS]etAttr. ........ r70851 | georg.brandl | 2009-03-31 13:26:55 -0500 (Tue, 31 Mar 2009) | 1 line #837577: note cryptic return value of spawn*e on invalid env dicts. ........ r70855 | georg.brandl | 2009-03-31 13:30:37 -0500 (Tue, 31 Mar 2009) | 1 line #5245: note that PyRun_SimpleString doesnt return on SystemExit. ........ r70857 | georg.brandl | 2009-03-31 13:33:10 -0500 (Tue, 31 Mar 2009) | 1 line #5227: note that Py_Main doesnt return on SystemExit. ........ r70866 | georg.brandl | 2009-03-31 14:06:57 -0500 (Tue, 31 Mar 2009) | 1 line #4882: document named group behavior a bit better. ........ r70867 | georg.brandl | 2009-03-31 14:10:35 -0500 (Tue, 31 Mar 2009) | 1 line #1096310: document usage of sys.__std*__ a bit better. ........ r70868 | georg.brandl | 2009-03-31 14:12:17 -0500 (Tue, 31 Mar 2009) | 1 line #5190: export make_option in __all__. ........ r70869 | georg.brandl | 2009-03-31 14:14:42 -0500 (Tue, 31 Mar 2009) | 1 line Fix-up unwanted change. ........ r70870 | georg.brandl | 2009-03-31 14:26:24 -0500 (Tue, 31 Mar 2009) | 1 line #4411: document mro() and __mro__. (I hope I got it right.) ........ r70871 | georg.brandl | 2009-03-31 14:30:56 -0500 (Tue, 31 Mar 2009) | 1 line #5618: fix typo. ........ r70872 | r.david.murray | 2009-03-31 14:31:17 -0500 (Tue, 31 Mar 2009) | 3 lines Delete out-of-date and little-known README from the test directory by consensus of devs at pycon sprint. ........ r70883 | georg.brandl | 2009-03-31 15:41:08 -0500 (Tue, 31 Mar 2009) | 1 line #1674032: return value of flag from Event.wait(). OKed by Guido. ........ r70885 | tarek.ziade | 2009-03-31 15:48:31 -0500 (Tue, 31 Mar 2009) | 1 line using log.warn for sys.stderr ........ r70893 | georg.brandl | 2009-03-31 15:56:32 -0500 (Tue, 31 Mar 2009) | 1 line #1530012: move TQS section before raw strings. ........ r70894 | benjamin.peterson | 2009-03-31 16:06:30 -0500 (Tue, 31 Mar 2009) | 1 line take the usual lock precautions around _active_limbo_lock ........ r70896 | georg.brandl | 2009-03-31 16:15:33 -0500 (Tue, 31 Mar 2009) | 1 line #5598: document DocFileSuite *args argument. ........ r70897 | benjamin.peterson | 2009-03-31 16:34:42 -0500 (Tue, 31 Mar 2009) | 1 line fix Thread.ident when it is the main thread or a dummy thread #5632 ........ r70903 | georg.brandl | 2009-03-31 16:45:18 -0500 (Tue, 31 Mar 2009) | 1 line #1676135: remove trailing slashes from --prefix argument. ........ r70905 | georg.brandl | 2009-03-31 17:03:40 -0500 (Tue, 31 Mar 2009) | 1 line #5563: more documentation for bdist_msi. ........ r70906 | georg.brandl | 2009-03-31 17:11:53 -0500 (Tue, 31 Mar 2009) | 1 line #1651995: fix _convert_ref for non-ASCII characters. ........ r70907 | georg.brandl | 2009-03-31 17:18:19 -0500 (Tue, 31 Mar 2009) | 1 line #3427: document correct return type for urlopen().info(). ........ r70915 | georg.brandl | 2009-03-31 17:40:16 -0500 (Tue, 31 Mar 2009) | 1 line #5018: remove confusing paragraph. ........ r70927 | georg.brandl | 2009-03-31 18:01:27 -0500 (Tue, 31 Mar 2009) | 1 line Dont shout to users. ........ r70933 | georg.brandl | 2009-03-31 19:04:33 -0500 (Tue, 31 Mar 2009) | 2 lines Issue #5635: Fix running test_sys with tracing enabled. ........ r70951 | georg.brandl | 2009-04-01 09:02:27 -0500 (Wed, 01 Apr 2009) | 1 line Add Maksim, who worked on several issues at the sprint. ........ r70960 | jesse.noller | 2009-04-01 11:42:19 -0500 (Wed, 01 Apr 2009) | 1 line Issue 3270: document Listener address restrictions on windows ........ r70962 | brett.cannon | 2009-04-01 12:07:16 -0500 (Wed, 01 Apr 2009) | 2 lines Ron DuPlain was given commit privileges at PyCon 2009 to work on 3to2. ........ r70963 | georg.brandl | 2009-04-01 12:46:01 -0500 (Wed, 01 Apr 2009) | 1 line #5655: fix docstring oversight. ........ r70964 | brett.cannon | 2009-04-01 12:52:13 -0500 (Wed, 01 Apr 2009) | 2 lines Paul Kippes was given commit privileges to work on 3to2. ........ r70998 | georg.brandl | 2009-04-01 16:54:21 -0500 (Wed, 01 Apr 2009) | 1 line In Pdb, stop assigning values to __builtin__._ which interferes with the one commonly installed by gettext. ........ r71001 | brett.cannon | 2009-04-01 18:01:12 -0500 (Wed, 01 Apr 2009) | 3 lines Add my initials to Misc/developers.txt. Names are now sorted by number of characters in the person's name. ........ r71006 | georg.brandl | 2009-04-01 18:32:17 -0500 (Wed, 01 Apr 2009) | 1 line Cache the f_locals dict of the current frame, since every access to frame.f_locals overrides its contents with the real locals which undoes modifications made by the debugging user. ........ r71008 | andrew.kuchling | 2009-04-01 19:02:14 -0500 (Wed, 01 Apr 2009) | 1 line Typo fix ........ r71010 | benjamin.peterson | 2009-04-01 19:11:52 -0500 (Wed, 01 Apr 2009) | 1 line fix markup ........ r71011 | benjamin.peterson | 2009-04-01 19:12:47 -0500 (Wed, 01 Apr 2009) | 1 line this should be :noindex: ........ r71019 | georg.brandl | 2009-04-01 21:00:01 -0500 (Wed, 01 Apr 2009) | 1 line Fix test_doctest, missed two assignments to curframe. ........ r71037 | r.david.murray | 2009-04-01 23:34:04 -0500 (Wed, 01 Apr 2009) | 6 lines 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. ........ r71056 | georg.brandl | 2009-04-02 12:43:07 -0500 (Thu, 02 Apr 2009) | 2 lines Actually the displayhook should print the repr. ........ r71094 | vinay.sajip | 2009-04-03 05:23:18 -0500 (Fri, 03 Apr 2009) | 1 line Added warning about logging use from asynchronous signal handlers. ........ r71101 | andrew.kuchling | 2009-04-03 16:43:00 -0500 (Fri, 03 Apr 2009) | 1 line Add some items ........ r71102 | andrew.kuchling | 2009-04-03 16:44:49 -0500 (Fri, 03 Apr 2009) | 1 line Fix 'the the'; grammar fix ........ r71103 | andrew.kuchling | 2009-04-03 16:45:29 -0500 (Fri, 03 Apr 2009) | 1 line Fix 'the the' duplication ........ r71106 | vinay.sajip | 2009-04-03 16:58:16 -0500 (Fri, 03 Apr 2009) | 1 line Clarified warning about logging use from asynchronous signal handlers. ........ r71119 | raymond.hettinger | 2009-04-04 00:37:47 -0500 (Sat, 04 Apr 2009) | 1 line Add helpful link. ........ r71123 | r.david.murray | 2009-04-04 01:39:56 -0500 (Sat, 04 Apr 2009) | 2 lines Fix error in description of 'oct' (issue 5678). ........ r71149 | georg.brandl | 2009-04-04 08:42:39 -0500 (Sat, 04 Apr 2009) | 1 line #5642: clarify map() compatibility to the builtin. ........ r71150 | georg.brandl | 2009-04-04 08:45:49 -0500 (Sat, 04 Apr 2009) | 1 line #5601: clarify that webbrowser is not meant for file names. ........ r71203 | benjamin.peterson | 2009-04-04 18:46:34 -0500 (Sat, 04 Apr 2009) | 1 line note how using iter* are unsafe while mutating and document iter(dict) ........ r71212 | georg.brandl | 2009-04-05 05:24:20 -0500 (Sun, 05 Apr 2009) | 1 line #1742837: expand HTTP server docs, and fix SocketServer ones to document methods as methods, not functions. ........ r71214 | georg.brandl | 2009-04-05 05:29:57 -0500 (Sun, 05 Apr 2009) | 1 line Normalize spelling of Mac OS X. ........ r71215 | georg.brandl | 2009-04-05 05:32:26 -0500 (Sun, 05 Apr 2009) | 1 line Avoid sure signs of a diseased mind. ........ r71216 | georg.brandl | 2009-04-05 05:41:02 -0500 (Sun, 05 Apr 2009) | 1 line #1718017: document the relation of os.path and the posixpath, ntpath etc. modules better. ........ r71217 | georg.brandl | 2009-04-05 05:48:47 -0500 (Sun, 05 Apr 2009) | 1 line #1726172: dont raise an unexpected IndexError if a voidresp() call has an empty response. ........ r71221 | vinay.sajip | 2009-04-05 06:06:24 -0500 (Sun, 05 Apr 2009) | 1 line Issue #5695: Moved logging.captureWarnings() call inside with statement in WarningsTest.test_warnings. ........ r71240 | georg.brandl | 2009-04-05 09:40:06 -0500 (Sun, 05 Apr 2009) | 1 line #5370: doc update about unpickling objects with custom __getattr__ etc. methods. ........	2009-04-05 19:13:16 +00:00
Alexandre Vassalotti	3cde7c752a	Undocument the existence of the memo attribute and its main use-case. ... Apparently, Guido don't like this behavior. [1] I also agree that the memo should be left as an implementation detail. [1]: http://mail.python.org/pipermail/python-dev/2009-March/086809.html	2009-04-03 06:58:20 +00:00
Alexandre Vassalotti	1102062abb	Emphasize that Unpickler.memo is not necessarily a dict.	2009-04-03 06:19:27 +00:00
Alexandre Vassalotti	9d7665df93	Add more examples in pickle documentation.	2009-04-03 06:13:29 +00:00
Georg Brandl	ae2dbe2543	#5486: typos.	2009-03-13 19:04:40 +00:00
Alexandre Vassalotti	bcd1e3a453	Clean up pickle usage examples.	2009-01-23 05:28:16 +00:00
Alexandre Vassalotti	f7d08c7d54	Issue 2980: Protocol 0 is not truly restricted to ASCII.	2009-01-23 04:50:05 +00:00
Alexandre Vassalotti	4a72a196b8	Remove obsolete note on binary-mode vs. text-mode file.	2009-01-23 04:46:05 +00:00
Georg Brandl	48310cd3f2	Remove trailing whitespace.	2009-01-03 21:18:54 +00:00
Alexandre Vassalotti	73b90a8d61	Improve pickle's documentation. ... Deprecate the previously undocumented Pickler.fast attribute. Revamp the "Pickling Class Instances" section. Reorganize sections and subsections. Clean up TextReader example.	2008-10-29 23:32:33 +00:00
Alexandre Vassalotti	d03928614f	More improvements to pickle's documentation. ... Add "Restricting Globals" section. Remove useless 'verbose' flag in the example dbpickle.py.	2008-10-24 01:32:40 +00:00
Alexandre Vassalotti	5f3b63ad6f	Improve pickle's documentation. ... Use double-space for ending a sentence. Add dbpickle.py example. Improve description about persistent IDs.	2008-10-18 20:47:58 +00:00
Alexandre Vassalotti	758bca6e36	Improve pickle's documentation. ... There is still much to be done, but I am committing my changes incrementally to avoid losing them again (for a third time now).	2008-10-18 19:25:07 +00:00
Benjamin Peterson	be149d0a0d	remove references of cPickle in the pickle docs (uhh. unlabeled footnotes)	2008-06-20 21:03:22 +00:00
Georg Brandl	0312494665	Remove last traces of cStringIO.	2008-06-10 15:50:56 +00:00
Georg Brandl	e6bcc9145e	Remove many "versionchanged" items that didn't use the official markup, ... but just some text embedded in the docs. Also remove paragraph about implicit relative imports from tutorial.	2008-05-12 18:05:20 +00:00
Alexandre Vassalotti	f7fa63dd55	Rename copy_reg module to copyreg. ... Updated documentation. Merged revisions 63042 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r63042 | alexandre.vassalotti | 2008-05-11 04:25:28 -0400 (Sun, 11 May 2008) | 5 lines Added module stub for copy_reg renaming in 3.0. Renamed copy_reg to copyreg in the standard library, to avoid spurious warnings and ease later merging to py3k branch. Public documentation remains intact. ........	2008-05-11 08:55:36 +00:00
Benjamin Peterson	e41251e864	Merged revisions 62490 via svnmerge from ... svn+ssh://pythondev@svn.python.org/python/trunk ........ r62490 | benjamin.peterson | 2008-04-24 20:29:10 -0500 (Thu, 24 Apr 2008) | 2 lines reformat some documentation of classes so methods and attributes are under the class directive ........	2008-04-25 01:59:09 +00:00
Mark Summerfield	b9e2304c44	dumps() and loads() work in terms of bytes objects not strings.	2008-04-21 14:47:45 +00:00
Georg Brandl	23e8db57e7	#2567: remove new-style/old-style class docs.	2008-04-07 19:17:06 +00:00
Georg Brandl	42f2ae0f69	#2558: document pickle protocol version 3. Thanks to Guilherme Polo.	2008-04-06 08:39:37 +00:00