Commit Graph

20043 Commits

Author SHA1 Message Date
Martin Panter 39267c21cc Issue #22088: Clarify base-64 alphabets and which characters are discarded
* There are only two base-64 alphabets defined by the RFCs, not three
* Due to the internal translation, plus (+) and slash (/) are never discarded
* standard_ and urlsafe_b64decode() discard characters as well
2016-02-23 22:30:50 +00:00
Martin Panter be9ddc1d11 Issue #26261: Clarify NamedTemporaryFile name attribute vs file.name 2016-02-22 10:10:00 +00:00
Martin Panter 3e85838ee9 Fix errors in XML-RPC client example code
* httplib.HTTP (deprecated and does not work) → HTTPConnection
* Server (deprecated) → ServerProxy
2016-02-22 09:10:54 +00:00
Vinay Sajip 35bb78ef7b Added simple threading example to logging cookbook. 2016-02-20 19:02:04 +00:00
Martin Panter 59b9a16e72 Issues #22468, #21996, #22208: Clarify gettarinfo() and TarInfo usage
* Make it more obvious gettarinfo() is based on stat(), and that non-ordinary
  files may need special care
* Filename taken from fileobj.name; suggest dummy arcname as a workaround
* Indicate TarInfo may be used directly, not just via gettarinfo()
2016-02-19 23:34:56 +00:00
Georg Brandl d6dd0e6560 Closes #20169: fix inner links random doc. 2016-02-19 08:57:23 +01:00
Martin Panter 94035f3aa7 Issue #15608: Improve socketserver module documentation
* Add headings for each concrete and mix-in class and list methods and
  attributes under them
* Fix class and method cross references
* Changed RequestHandler to BaseRequestHandler and added class heading
* Pull out Stream/DatagramRequestHandler definitions
* Reordered the request handler setup(), handle(), finish() methods
* Document constructor parameters for the server classes
2016-02-19 03:27:46 +00:00
Benjamin Peterson 51b13e53fc fix typo (closes #26378) 2016-02-17 23:42:46 -08:00
Georg Brandl c665ff6177 Closes #26320: fix stylesheet after Sphinx update. 2016-02-10 13:44:29 +01:00
Martin Panter 53ae0ba6e3 Issue #26304: Change "allows to <verb>" to "allows <verb>ing" or similar
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
Martin Panter 2dafcc25a9 Issues #26310, #26311: Fix typos in the documentation 2016-02-10 01:17:51 +00:00
Gregory P. Smith 3b5d61fa6c Clarify "cardinality of" as "number of elements in" as many readers do
not have a math vocabulary.
2016-02-08 09:59:14 -08:00
Serhiy Storchaka 36ae29c759 Issue #26198: Fixed error messages for some argument parsing errors.
Fixed the documented about buffer overflow error for "es#" and "et#" format
units.
2016-02-08 01:05:48 +02:00
Martin Panter 00f19eff3e Issue #25179: Preparatory cleanup of existing docs on string formatting
* There was a link pointing to the section on the string.Formatter class (and
  multiple links in Python 3), when the section on the common format string
  syntax is probably more appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
  and this is tested in Python 3; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Senthil Kumaran 9c61f2e45b Fix userinfo example presented in urllib2 howto. 2016-02-05 19:35:57 -08:00
Zachary Ware bf3b89782f Python for .NET has moved to Github.
Reported by Denis Akhiyarov on docs@
2016-02-03 22:05:46 -06:00
Martin Panter 1d269c1067 Issue #26244: Clarify default zlib compression level in documentation
Based on patch by Aviv Palivoda.
2016-02-03 07:06:33 +00:00
Martin Panter a339e86dc0 Issue #19023: Document ctypes array and pointer classes
Also add some more tests. Based on patch by Sye van der Veen.
2016-01-29 10:12:19 +00:00
Berker Peksag b031adcd51 Fix typo in test.rst
Reported by Mike Scalora on docs@p.o.
2016-01-25 08:24:57 +02:00
Victor Stinner b4929843a9 doc: i18n HTML templates
Issue #25907: Use {% trans %} tags in HTML templates to ease the translation of
the documentation. The tag comes from Jinja templating system, used by Sphinx.

Patch written by Julien Palard.
2016-01-23 12:55:11 +01:00
Gregory P. Smith 20d4f1b9e4 Per issue21949 and issue1629: Document the Py_SIZE, Py_TYPE, Py_REFCNT macros.
This was already done in the 3.5 branch; this just does the same in the 2.7
branch.
2016-01-22 13:17:41 -08:00
Berker Peksag f9aa599c0a Issue #18620: Improve Pool examples in multiprocessing documentation
A single call to Pool.apply_async() will create only one process. To use all
of the pool's processes, it should be invoked multiple times:

    with Pool(processes=4) as pool:
        results = [pool.apply_async(func, ()) for i in range(4)]

Patch by Davin Potts.
2016-01-22 00:07:00 +02:00
Victor Stinner 047ddfb64d Issue #26106: doc: Move text of licenses to parsed literal block
This change helps to ignore text of PSF, BEOPEN.com and CNRI licenses when
translating the documentation. Patch written by Julien Palard who is
translating Python 3.5 doc to french. Text of other licenses already used
preformatted format.
2016-01-21 08:56:00 +01:00
Senthil Kumaran 762d761d65 issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs. 2016-01-20 03:18:48 -08:00
Senthil Kumaran 5e90cd9b32 Issue26017 - Suggest enclosing command args in double quotes when using characters which get interpreted by shell. 2016-01-17 18:45:11 -08:00
Senthil Kumaran e57c957ff9 Issue26142 - Fix a formatting bug in c-api intro doc. 2016-01-17 17:05:14 -08:00
Senthil Kumaran 11a73890d3 Issue26035 - Correct the argument names used in the docs of the traceback module. Make it consistent with module args. 2016-01-15 22:13:16 -08:00
Martin Panter 264dcb7290 Issue #26127: Fix links in tokenize documentation 2016-01-16 04:32:52 +00:00
Senthil Kumaran 1826f6369c Issue26097 - Fix the TextTestRunner documentation, mention all the arguments of the class.
Patch contributed by Nicolas Évrard.
2016-01-14 21:57:57 -08:00
Ezio Melotti 4cb7fca89f #25574: backport glossary doc fix about hash and id of user-defined classes. 2016-01-12 11:36:25 +02:00
Ezio Melotti 7f62062be1 #19006: fix wording in unittest docs. 2016-01-12 11:03:10 +02:00
Ezio Melotti 50ba447ab7 #25517: fix regex in the regex howto. Patch by Elena Oat. 2016-01-12 00:07:23 +02:00
Ezio Melotti 167c336725 #25991: fix readline example to limit history size. Patch by Daniel Dye. 2016-01-11 23:30:15 +02:00
Benjamin Peterson c2ccb73e8a delete old crypto prose (closes #26066) 2016-01-09 23:55:47 -08:00
Senthil Kumaran 145b1c6c2a Issue23675 - A tiny clarification in the MRO glossary term. 2016-01-09 22:36:13 -08:00
Senthil Kumaran ee98860e5f Issue20969 - Set the Epub Author and Epub Publisher in Python docs. 2016-01-08 01:05:57 -08:00
Benjamin Peterson c6fa90c7ca fix typo in unittest docs (closes #26046)
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
Berker Peksag 6b51ddfa22 Issue #5501: Clarify that invoking freeze_support() on non-Windows platforms has no effect
Patch by Davin Potts and Camilla Montonen.
2016-01-07 18:49:53 +02:00
Senthil Kumaran 788db63265 Fix issue18918 : Attach the pydoc documentation for 'FILES' topic.
Also rebuilt the pydoc_data with this change.
2016-01-06 03:54:18 -08:00
Senthil Kumaran e2e6b54a4c Backport documentation improvement.
Issue24898 - Improve str.find documentation.

Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 18:07:06 -08:00
Senthil Kumaran 8a4e7fd678 Backport doc improvements for Issue21221 - Explain the usage of tm_isdst
attribute of mktime, with valid values and meaning.

Patch contributed by Andrew Scheller.
2016-01-03 01:03:40 -08:00
Zachary Ware fa45a0e3d2 Fix grammar.
Reported by Anatoly Techtonik on docs@
2016-01-01 12:22:16 -06:00
Benjamin Peterson f30bad284b remove some copyright notices supserseded by the toplevel ones 2016-01-01 11:53:47 -06:00
Benjamin Peterson 1f40ece2d7 2016 will be another year of writing copyrighted code 2016-01-01 10:23:45 -06:00
Martin Panter d77fe94b4e Issue #22088: Port base64 character ignoring doc and test from 857d9fe60169 2015-12-14 03:41:59 +00:00
Martin Panter edd6a817d1 Issue #20837: Base-64 alphabet clarification from revision 1853679c6f71 2015-12-14 02:54:40 +00:00
R David Murray b75adccd0a #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:14 -05:00
Zachary Ware 6b93ca6a3b Clarify that only *documentation* bugs should go to docs@python.org 2015-12-09 01:53:44 -06:00
Vinay Sajip c9625c8e4b Issue #25508: Clarify documentation on LogRecord args attribute. 2015-11-24 23:18:30 +00:00
Martin Panter 402803b642 Issue #23200: Document that max_length=0 is not supported 2015-11-18 00:59:17 +00:00