7026cd92c0
[2.7] Correct typo in configparser.rst (GH-1012) (GH-1026)
...
(cherry picked from commit 01fa9ae546
2017-04-09 15:16:06 -07:00
ab16dc180e
bpo-29506: Clarify deep copy note in copy module
...
The reference to administrative data was confusing to readers,
so this simplifies the note to explain that deep copying may copy
more then you intended, such as data that you expected to be
shared between copies.
Patch by Sanyam Khurana.
2017-04-09 20:57:29 +10:00
7f85947106
[2.7] bpo-19225: Lack of c api exceptions doc ( #964 )
...
* Keep the c-api exception doc up-to-date
cherry-pick'ed from ec1f5df..e3d6db3 and fix conflict
2017-04-08 09:19:24 +03:00
9b50786bc7
Fix references within buffer protocol docs ( #1016 )
2017-04-06 20:36:43 +03:00
5aa913d723
bpo-29952: Use usual terminology of dict (GH-924)
...
s/keys and elements/keys and values/
(cherry picked from commit cdcac039fb
2017-03-31 15:53:25 +09:00
2ee01ecf41
[2.7] bpo-22392: Improve documentation for __getinitargs__ (GH-899)
2017-03-30 13:39:06 -07:00
3ceca68741
bpo-29917: DOC: Remove link from PyMethodDef ( #890 ) ( #896 )
...
(cherry picked from commit c3c7ef0885
2017-03-29 22:29:12 -07:00
fd704a02ca
bpo-16011: clarify that 'in' always returns a boolean value (GH-152) (GH-883)
...
(cherry picked from commit 0ae7c8bd61
2017-03-29 14:10:13 -07:00
6f95b37f29
bpo-29888: Fix the link referring to "Python download page" (GH-823)
2017-03-26 22:59:14 -04:00
de65804d5c
Insert a missing semicolon in sgmllib documentation ( #772 )
2017-03-22 21:12:36 +02:00
dae5482c9c
fix function name in tabnanny documentation (GH-764)
2017-03-22 15:22:44 +08:00
91f79db02a
bpo-29856: Fix typo in curses documentation (GH-730) (GH-733)
...
From Shifted Dxit -> Shifted Exit in Doc/library/curses.rst
(cherry picked from commit 64508780d7
2017-03-19 20:55:34 -07:00
4ec14c2360
fix parameter names in ftplib documentation (GH-656)
2017-03-13 10:41:38 +08:00
309fb90f68
Insert the line which should not have been deleted ( #581 )
...
see [bpo-29772](http://bugs.python.org/issue29772 )
2017-03-09 08:54:27 -07:00
fc59e5c707
bpo-29709: Improve Boolean Operations documentation ( #433 ) ( #438 )
...
(cherry picked from commit 8eb531d9db
2017-03-03 13:34:52 -08:00
c8e20218d7
bpo-22594: Add a link to the regex module in re documentation (GH-241) (GH-321)
...
(cherry picked from commit ed6795e46f
2017-02-26 08:56:21 -08:00
9436bbd87b
bpo-29165: doc: make extending/newtypes more Python 3 friendly (GH-211)
...
* Use PyVarObject_HEAD_INIT instead of PyObject_HEAD_INIT on type struct header.
* Backport many minor fixes from Python 3 doc to minimize diff.
2017-02-21 21:12:03 +09:00
af9a40d58c
[2.7] Change some mercurial/ hg.python.org references. ( #8 ) ( #183 )
...
(cherry picked from commit b2ee40ed9c
2017-02-19 17:49:54 -08:00
cf44d957ec
bpo-29520: doc: fix deprecation warning from 'defindex' template (GH-180)
2017-02-20 09:45:55 +09:00
4bfb603810
Remove redundant footnote ( #181 )
...
It was accidentally added in cc79837
2017-02-19 22:32:51 +03:00
e15259c2df
bpo-28929: Link the documentation to its source file on GitHub ( #38 )
...
Change the documentation's `Show Source` link on the left menu
to GitHub source file.
2017-02-12 13:07:33 -08:00
52b8c5591b
[backport to 2.7] Change documentation's `Show Source` link to GitHub ( #44 )
...
* Support "bpo-" in Misc/NEWS (#1 )
Change the url to 2.7
(cherry picked from commit 79ab8be05f
2017-02-12 12:59:20 -08:00
5c329882fa
bpo-29474: Improve documentation for weakref.WeakValueDictionary ( #11 )
...
There were some grammatical errors in weakref.WeakValueDictionary
documentation.
2017-02-10 19:44:57 -06:00
4e1e30dae9
Issue #26355 : Specify canonical URLs in docs pages
...
Add canonical header link on each page to corresponding major version of the documentation.
Patch by Matthias Bussonnier.
2017-02-09 17:00:31 +01:00
d9fb4a97f3
Issue #29371 : Clarify bitwise OR operation in doctest option flags.
2017-02-06 20:30:10 -08:00
ebfb2f76c5
Issue #29329 : Improve documentation for hex(). Patch by Ammar Askar
2017-02-01 22:27:02 -08:00
40ba60f6bf
Issue #29381 : Clarify ordering of UNIX shebang line as source encoding line
2017-02-01 21:14:47 -08:00
60a1b351ca
Issue #12067 : Rewrite Comparisons section in the language reference
...
Some of the details of comparing mixed types were incorrect or ambiguous.
Added default behaviour and consistency suggestions for user-defined classes.
Based on patch from Andy Maier.
2017-01-21 05:14:56 +00:00
19048c3ada
Add clarity to the warning on certificate verification in urllib.
2017-01-27 23:05:34 -08:00
1bfbe4fdbf
issue26149 - Point to Wiki for Editors and Python IDEs on Unix.
...
Patch contributed by Mariatta Wijaya.
2017-01-25 01:46:33 -08:00
efba28c580
Issue #29189 : Fix indentation in RST markup
2017-01-24 00:22:45 +00:00
1b31d284e1
Issue #29274 : tests cases → test cases
2017-01-18 12:14:29 +00:00
ea9342ae6d
Avoid line breaks after hyphens, otherwise they are turned into spaces
2017-01-14 09:53:23 +00:00
12344883ff
Issue #15527 : remove double parens by changing markup.
...
Patch by Serhiy Storchaka.
2017-01-14 09:40:11 +00:00
c7496ee6da
Fix spelling and markup in documentation and code comment
...
* Mark up ``--help`` to avoid generating an en dash
* Use forward slash in Unix command line with a dollar sign ($) prompt
2017-01-14 08:51:49 +00:00
a6f10ca4d1
Closes #28130 : Documented that time.tzset() updates time module globals.
...
Thanks Greg Bengeult for the patch.
2017-01-12 15:06:34 -05:00
da8ea3a59d
Issue #29217 : Fix the wrong type description of UUID.variant.
2017-01-10 11:27:07 +08:00
10434d6cb6
Issue #29189 : Fix broken indentation in FancyURLopener documentation
2017-01-07 09:17:02 +03:00
9b7ae96b98
Issue #29023 : Clarify that ints and longs are always deterministic seeds for random.
2017-01-06 16:13:37 -08:00
ea02cdc7ec
ring in 2017 for Python
2017-01-01 22:04:13 -06:00
a19fd46132
Issue #29112 : Fix a questionable wording in sequence doc.
2016-12-30 11:55:28 +08:00
58c2c6ebb8
Issue #29078 : Add the missing import in datetime.time doc example.
...
Patch by Dhushyanth Ramasamy.
2016-12-27 12:21:28 +08:00
427ca62dde
Issue #1446619 : Account for negative slice direction in description
...
Based on suggestion from Fumihiro Bessho.
2016-12-24 08:25:15 +00:00
3698bd262f
Issue #29004 : Document binascii.crc_hqx() implements CRC-CCITT
2016-12-24 07:53:57 +00:00
c04957531e
Update documentation index sidebar for 3.6.0 release.
2016-12-23 04:12:46 -05:00
c4f91baa35
Issue #29038 : Fix duplicate get_ca_certs() doc entry.
2016-12-23 11:10:19 +08:00
00ebffe5e1
Grammatical fixes for d95f19892fd0
2016-12-22 10:03:11 -08:00
f6447e0065
doc: Suggest to hash(tuple of attr) rather than XOR
...
Issue #28383 : __hash__ documentation recommends naive XOR to combine but this
is suboptimal. Update the doc to suggest to reuse the hash() method using a
tuple, with an example.
2016-12-19 13:15:35 +01:00
37eb788e9e
Update the porting HOWTO
2016-12-17 12:38:54 -08:00
30ad6e2c46
Issue #14061 : Misc fixes and cleanups in archiving code in shutil.
...
Improved the documentation and tests for make_archive().
Improved error handling when corresponding compress module is not available.
External zip executable is now used if the zlib module is not available.
2016-12-16 19:04:17 +02:00
3eb92e06df
Issue #28916 : No special case for leading zeros with %x alternative form
2016-12-11 03:51:44 +00:00
3797922ad9
Issue #28900 : Update documentation sidebar for 3.6.0rc.
2016-12-07 23:34:23 -05:00
8b5528782a
Fixed mismatching title overline.
2016-12-04 15:42:13 +02:00
e7f555b969
Fixed double hyphens that are rendered to literal en-dashes in the documenation.
2016-12-04 10:20:18 +02:00
32b3734866
Issue #28440 : No longer add /Library/Python/site-packages, the Apple-supplied
...
system Python site-packages directory, to sys.path for macOS framework builds.
The coupling between the two Python instances often caused confusion and, as
of macOS 10.12, changes to the site-packages layout can cause pip component
installations to fail. This change reverts the effects introduced in 2.7.0
by Issue #4865 . If you are using a package with both the Apple system Python
2.7 and a user-installed Python 2.7, you will need to ensure that copies of
the package are installed with both Python instances.
2016-12-03 02:14:09 -05:00
1ae56fb9ee
Issue #21818 : Fixed references to classes that have names matching with module
...
names.
2016-12-02 23:13:42 +02:00
b398d2c2bf
Issue #28771 : Correct documentation of signatures using const
2016-12-01 01:32:16 +00:00
ed82604e3f
Issue #25701 : Document that some C APIs can both set and delete items
...
Also document that using the dedicated functions to delete items is
preferred. Using PyObject_SetAttr/String() and PySequence_SetItem/Slice() for
deletion is deprecated.
2016-11-30 10:32:40 +00:00
a52b567a3f
Issue #28820 : Fix spelling of “practice” as a noun
2016-11-30 10:18:45 +00:00
0092bc7279
Issue #28763 : Use double hyphens (rendered as en-dashes) in numerical ranges
...
in the documentation.
2016-11-26 13:43:39 +02:00
e4a147b1bd
Fixed the documentation of the structure PyMethodDef.
...
The fields ml_name and ml_doc are of type "const char *" rather of "char *".
2016-11-21 11:37:18 +02:00
3738ef4294
Change double hyphens (en dashes) to em (longer) dashes
2016-11-21 00:21:39 +00:00
58b6b985a0
Fixed the documentation of parse_constant argument in json.load().
...
parse_constant doesn't get called on 'null', 'true', 'false' since 3.1/2.7.
2016-11-12 22:47:16 +02:00
fed0883e94
Issue #28615 : Backport imaginary/complex number text from 3.x.
...
Patch by Mariatta Wijaya.
2016-11-11 19:09:50 -05:00
b26a7d18ef
Fix spacing after C++ in documentation
2016-11-05 03:15:20 +00:00
b858d7f074
Issue #28513 : Documented command-line interface of zipfile.
2016-11-02 12:05:54 +02:00
39d74a9108
Issue #26638 : Cannot directly link to main option from the “timeit” module
...
This seems to be because the “timeit” module defines its own set of options
2016-10-30 05:41:04 +00:00
e3e362e398
Issue #26638 : Mask undefined CLI options to defeat new Sphinx warnings
2016-10-30 05:19:02 +00:00
ee01fccc69
Issue #26638 : Disable inappropriate links to Python interpreter options
2016-10-30 05:24:45 +00:00
f831fd3f19
Issue #22949 : Documented that fnmatch.translate() is for use with re.match().
2016-10-27 22:47:08 +03:00
d585c52511
Issue #28496 : Mark up constants 0, 1 and -1 that denote return values or
...
special input values as literal text.
2016-10-27 21:41:04 +03:00
cb042e0448
Issue #19795 : Fixed formatting a table.
2016-10-19 19:37:20 +03:00
dc0e3a8907
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:30:16 +03:00
e3d5787a25
Issue #19795 : Mark up True and False as literal text instead of bold.
2016-10-19 16:43:18 +03:00
ad13f338ce
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:10 +03:00
5df6d48ce5
Issue #27896 : Allow passing sphinx options to Doc/Makefile
...
Patch written by Julien Palard.
2016-10-16 19:14:23 +02:00
197332ae5a
Issue #27800 : Document limitation and workaround for multiple RE repetitions
2016-10-15 01:18:16 +00:00
50f40724c5
Issue #18789 : Update XML vulnerability table to use Safe/Vulnerable instead of No/Yes. (backport to 2.7)
2016-10-13 14:34:20 -07:00
0ea51b18d5
Issue #18287 : PyType_Ready() now checks that tp_name is not NULL.
...
Original patch by Niklas Koep.
2016-10-07 23:24:35 +03:00
dace77c530
Issue #28815 : Change '?' to '<module>' in some doc examples.
...
Patch by Mariatta Wijaya.
2016-09-30 15:38:41 -04:00
6f959d07db
Issue #26550 : Fix typo in webservers HOWTO
...
Reported by Alejandro Soini.
2016-09-29 02:32:51 +03:00
de2d4d2048
Issue #26439 : Document that RTLD_NOW is always added
2016-09-27 05:10:40 +00:00
47f190a072
Make 3.7 the current dev version in the html version of the docs.
2016-09-20 14:58:38 -04:00
84a449abb3
Issue #28104 : More accurately document set method signatures
2016-09-12 23:43:03 -07:00
87bcc1d646
Issue #15308 : Add 'interrupt execution' (^C) to Shell menu.
...
Patch by Roger Serwy, updated by Bayard Randel.
2016-09-12 01:49:55 -04:00
63c79966d5
Issue #26557 : Note that mapping view methods are not present in UserDict or shelves.
2016-09-11 20:38:27 -07:00
0954ac1b5c
Issue #23105 : Updated documentation on open() flag constants.
2016-09-11 15:11:50 +01:00
fcc8a0f0f5
Correct spelling in documentation and code comments
2016-09-10 10:38:28 +00:00
ba5480b656
Issue #27993 : Fix problems with the plural “objects” in docs and comments
2016-09-08 05:39:59 +00:00
039f184654
#26209 : Clarify type of *localaddr*/*remoteadr* in smtpd docs.
2016-09-07 14:09:51 -04:00
4e64c2c838
Fix ssl documentation and remove merge accident
2016-09-06 23:41:37 +02:00
d988f429fe
Issues #27850 and #27766 : Remove 3DES from ssl default cipher list and add ChaCha20 Poly1305.
2016-09-06 20:06:47 +02:00
c2fc7c4f53
Issue #26470 : Port ssl and hashlib module to OpenSSL 1.1.0.
2016-09-05 23:37:13 +02:00
56c5152370
Issue #27706 : Document that random.seed() is non-deterministic when PYTHONHASHSEED is enabled
2016-08-31 14:57:32 -07:00
580ca656bd
Backport spelling fix.
2016-08-30 16:57:53 -04:00
e63af905a4
Issue #27861 : Fixed a crash in sqlite3.Connection.cursor() when a factory
...
creates not a cursor. Patch by Xiang Zhang.
2016-08-29 14:29:55 +03:00
558c0de2d4
Issue #25564 : Mention exec and __builtins__ in IDLE-console difference section.
...
Do not print charrefs outside of the text proper (like '—»»»» ').
2016-08-25 01:21:54 -04:00
99496760c7
Fix some spelling errors
2016-08-20 08:00:53 +00:00
4ae4e7cbc0
#27753 : fix typo (name->named).
2016-08-13 14:46:23 -04:00
af0b38f814
Issue #27720 : Fix error in eng_to_decimal docs and add examples from the specification.
2016-08-13 11:10:23 -07:00
fa1ce08fc6
Issue #27205 : Fix doctests in Doc/library/collections.rst
2016-08-09 17:28:33 -05:00
d379d6377f
Issue #27204 : Fix doctests in Doc/howto
...
Initial patch by Jelle Zijlstra.
2016-08-09 17:03:32 -05:00
8f1dd224e0
Issue #26462 : Doc: avoid literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
75d7b615ba
Prevent HTTPoxy attack (CVE-2016-1000110)
...
Ignore the HTTP_PROXY variable when REQUEST_METHOD environment is set, which
indicates that the script is in CGI mode.
Issue reported and patch contributed by Rémi Rampin.
2016-07-30 05:49:53 -07:00
a850ef698e
Issue #27626 : Spelling fixes in docs, comments and internal names
...
Based on patch by Ville Skyttä.
2016-07-28 01:11:04 +00:00
e2eacc02bc
Issue #23943 : Fix typos. Patch by Piotr Kasprzyk.
2016-07-28 03:04:04 +00:00
2955ef759e
Issue #25393 : Fix probable copy/paste error in resource docs
...
Patch by Alakshendra Yadav.
2016-07-19 16:41:20 -05:00
cdb8be4f40
Issue #27528 : Document and test warning messages must match at beginning
2016-07-19 02:26:38 +00:00
bf2dca96fb
English spelling and grammar fixes
2016-07-11 07:51:37 +00:00
b362f75f6e
Issue #25523 : Correct "a" article to "an" article
...
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
to fix the grammar.
2015-11-02 03:37:02 +00:00
3626e5ef2a
Issue #4945 : Improved the documenting of boolean arguments in the json module.
...
Based on patch by Gabriel Genellina.
2016-06-30 13:58:58 +03:00
bc44893155
Issue #27416 : clarify copy doc
...
Patch written by R. David Murray.
2016-06-30 11:50:23 +02:00
aaa4baf4e5
Issue #27370 : Use t for an iterable in mutable sequence ops
2016-06-23 00:53:05 +00:00
8da85a173a
Fix the urllib.parse.urljoin docs. Reported by Bo Bayles in docs list.
2016-06-22 00:56:22 -07:00
4e6e565368
Fix English spelling and grammar errors
2016-06-20 07:52:50 +00:00
4183387e79
Issue #27294 : Numerical state in the repr for Tkinter event objects is now
...
represented as a compination of known flags.
2016-06-18 22:08:49 +03:00
d51b0f2188
Issue #24314 : Add links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
b311eeefb8
Docs: add html-stable autobuild variant
2016-06-15 08:57:32 +02:00
0e212331ea
Issue #12855 : Document what exactly unicode.splitlines() splits on
...
Also synchronize with Python 3 examples. Based on patches by Matthew Boehm
and Alexander Schrijver.
2016-06-01 09:39:46 +00:00
fc0a55fed9
Issue #16182 : Backport documentation of set_pre_input_hook() availability
2016-06-14 08:45:43 +00:00
0d8657721e
Issue #15657 : Delete incorrect statement from PyMethodDef documentation
2016-06-12 16:37:57 +03:00
056cbfdc51
Fix typo in documentation
2016-06-12 06:14:03 +00:00
e52140caf1
#16484 : Change PYTHONDOCS to "https:", and fix links to use lowercase
...
Implementation by Sean Rodman; test by Kaushik Nadikuditi.
2016-06-12 05:25:16 +00:00
be2bb472b0
Issue #16484 : PYTHONDOCS still uses “http:” in Python 2
2016-06-12 04:38:34 +00:00
33b19ca77f
Issue #24617 : Add comment for os.mkdir about mode quirks
2016-06-02 15:41:20 -04:00
c9813d83f7
Issue #20699 : Document that “io” methods should accept memoryview
...
This matches the usage by BufferedReader, BufferedWriter, etc. Also document
and test that the write() methods should only access their argument before
they return.
2016-06-03 05:59:20 +00:00
d6cecd30af
Issue #8491 : Add link to Gnu Readline configuration documentation
2016-06-10 00:27:46 +00:00
24b9e1a00d
[Issue 15476] Make "code object" its own entry in the index
2016-06-02 19:26:51 -04:00
d5982d0433
Issue #23275 : Backport empty square bracket assignment documentation fix
2016-06-08 12:44:30 +00:00
6af1c49bb4
Issue #25738 : Don’t send message body for 205 Reset Content
...
Patch by Susumu Koshiba.
2016-06-08 07:16:14 +00:00
835d392d8a
Issue #26014 : Guide 2.7 users to the new packaging documentation:
...
- the top-level 2.7 docs page now links to the newer doc pages
(installing and distribution) rather than the legacy ones
- the legacy install and distutils pages are now labeled as "legacy"
- the library/distutils page is updated to match the 3.x version
- "See also" links to the new docs are now provided in the legacy pages
- links to setuptools documentation have been updated
(original patch by Susan Sun)
2016-06-05 17:35:43 -07:00
06cd1c3d36
Issue 27216: Fix typo (noticed by Alex Chan).
2016-06-04 09:39:42 -07:00
e6167e33e6
[backport to 2.7] - issue8519 - Reference termios and ioctl manual pages in the library documentation.
2016-06-02 23:51:22 -07:00
c3cd60e764
issue25931: document that socketserver.Forking* are unavailable on platforms
...
that support os.fork.
2016-06-03 05:48:23 +00:00
3017cef009
#13784 : fix xml.sax.reader getColumn/LineNumber docs.
...
verification and patch by Emily Morehouse.
2016-06-02 15:13:37 -04:00
382d041131
note that Py_VISIT handles NULL ( closes #27183 )
2016-06-02 11:35:59 -07:00
56da8fa581
Issue #12243 : Remove redundant availability notes from getpass docs
...
I wonder why I keep forgetting 2.7 :P
Patch by Bryce Verdier.
2016-06-01 18:32:42 -07:00
fcd7d34afb
Issue #25570 : Add example of customizing User-Agent via add_header()
2016-06-01 08:20:22 +00:00
200a615774
Issue #27125 : Remove duplicated words from documentation and comments
2016-05-30 04:04:50 +00:00
739b3737f2
issue27043 - Explain the inspect.cleandoc behavior on synopsis line and other lines.
...
Patch contributed by Nathan Harold.
2016-05-29 20:38:55 -07:00
b44c4520d9
Issue #27125 : Fix various errors like “will [be] inherited”
2016-05-29 08:13:58 +00:00
cb0fc27f20
Issue 25926: Clarify that the pure python equivalents are only approximate.
2016-05-28 00:26:41 -07:00
5720493172
Issue #26553 : Capitalization of HTTP, HTTPS, FTP, and URL
...
Patch by Anish Shah and Aatish Neupane.
2016-05-28 02:33:05 +00:00
6ecfab85d9
Issue #5784 : Cannot test wbits=0 unless we know we have zlib v1.2.3.5
2016-05-27 11:20:21 +00:00
9c946bbf20
Issue #5784 : Expand documentation and tests for zlib wbits parameter
...
Based on documentation by AM Kuchling.
2016-05-27 07:32:11 +00:00
5541aa35d0
stop talking about svn
2016-05-26 23:18:51 -07:00
496790b541
remove cruft from Schwarzian transform section
2016-05-26 22:55:49 -07:00
01d2580d4b
"Numeric Python" -> "NumPy"
2016-05-26 22:51:32 -07:00
5db0b3396e
Fix Issue #21528 - Fix documentation typos
2014-05-20 12:58:38 -04:00
171deb279c
#5486 : typos.
2009-03-13 19:04:40 +00:00
880e4f3ca1
#9911 : doc copyedits.
2010-09-21 14:48:28 +00:00
658903e1ad
Fix typo in library/ipc.rst
2014-02-09 05:54:13 -08:00
12d547a80d
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 13:45:32 +03:00
4f23cabc16
Corrections for a/an in code comments and documentation
2016-05-08 13:45:55 +00:00
f2f1c57b7e
Fix typos in comments, documentation and test method names
2016-05-08 13:18:25 +00:00
cdbf38cbd6
Issue #26512 : Clarify Integral; tidy up table of rounding functions
...
Based on patch by Julien.
2016-05-08 12:47:37 +00:00
b4905efe23
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:50:12 +03:00
c145da0751
Issue #26889 : Fixed hyperlinks formatting.
2016-05-07 10:06:53 +03:00
63d2fca866
Issue #26889 : Tweaked xmlrpclib documentation.
2016-05-07 08:44:58 +03:00
1ca93b621c
Issue #26962 : Backport 23d986228c6b to 2.7
2016-05-05 11:05:49 +03:00
7d03c84634
Clarify IDLE-console differences with respect to the sys module.
...
The reload(sys) effect was the crux of a Stackoverflow question.
2016-05-02 18:17:19 -04:00
065b40c0bd
Issue #21746 : Remove BaseResult reference from urlparse documentation
...
BaseResult no longer exists and it has been replaced by namedtuple.
Patch by Matthew Gilson.
2016-04-30 18:36:31 +03:00
44f99d0aaf
fileinput.hook_encoded() uses io.open(), not codecs.open().
2016-04-27 23:07:25 +03:00
b6886505a6
Issue #26672 : Fix regrtest example in test.rst
...
Reported by Axel Luttgens.
2016-04-27 08:58:32 +03:00
11cc513e8b
Issue #20598 : Replace trivial split() calls with lists in argparse docs
2016-04-26 11:33:46 +00:00
ff64b3a532
Issue #24715 : Improve sort stability example
2016-04-26 01:09:32 -07:00
167c81d5ed
Issue #23986 : Note that the in-operator for lists and tuples check identity before equality.
2016-04-26 00:59:16 -07:00
b31c87bfcf
backport fix for Issue #26804 .
...
urllib.request will prefer lower_case proxy environment variables over
UPPER_CASE or Mixed_Case ones.
2016-04-25 09:17:54 -07:00
bca06ccb3e
fix python 3 mod init function declaration ( closes #26827 )
2016-04-22 23:43:10 -07:00
5b48fa9fa4
Fix spelling (inital), grammar (may translates) in documentation, comments
2016-04-19 04:03:41 +00:00
9a118f1dc3
Issue #26778 : Fixed "a/an/and" typos in code comment and documentation.
2016-04-17 09:37:36 +03:00
16b83b1f66
Issue #24173 : Fix curses.wrapper link in curses HOWTO
2016-04-16 23:15:39 +03:00
bf02d18844
Fix typos in code comment and documentation
2016-04-16 09:28:57 +00:00
fb45216da8
Issue #26638 : Fix links to some CLI options
...
Disable inappropriate links to Python interpreter options. Also make CLI
section label in timeit less ambiguous.
2016-04-16 04:59:38 +00:00
87d9de6354
Issue #25314 : Remove confused statement about const argument
2016-04-09 03:49:48 +00:00
6a8163a928
Correct “an” → “a” with “Unicode”, “user”, “UTF”, etc
...
This affects documentation and code comments.
2016-04-15 02:14:19 +00:00
a364c12042
Issue #26747 : Document that InstanceTypes only works for old-style classes
...
Patch by Nan Wu.
2016-04-14 15:51:22 +03:00
b9b98c81fd
Update susp-ignore file ( #25910 ).
2016-02-28 21:13:23 +01:00
d47b99643b
Issue #25496 : Document compresslevel defaults to 9, by Hamza T Khan
2016-04-13 03:24:06 +00:00
5892ab1b4a
Clarify greedy-qualifier example, avoid HTML.
2016-04-12 07:51:41 +02:00
92a5f47d2c
Issue #25910 : Fixed more links in the docs.
2016-04-11 17:32:33 +03:00
fdcb535893
Issue #25910 : Fixed dead links in the docs.
2016-04-11 12:18:56 +03:00
6e0b44ef9e
Closes #25910 : fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch.
2016-02-26 19:37:12 +01:00
aad86a6015
Issue #6953 : Rearrange and expand Readline module documentation
...
* Group functions into six new subsections
* Document the underlying Readline function or variable accessed
* get_history_length() returns the history file limit
* clear_history() is conditionally compiled in
* Clarify zero and one bases for history item indexes
* parse_and_bind() uses its argument directly as an init line
* Change "command line" to "line buffer" for consistency
* read_init_file() also executes the file
* read_history_file() replaces the previous history
* write_history_file() overwrites any existing file
* Differentiate history file lines from history list items, which could be
multi-line
* Add more information about completion, also addressing Issue #10796
* libedit (Editline) may be used on any platform; detection is OS X specific
2016-04-05 07:37:22 +00:00
ce9f8e2492
Issue #26678 : Fix datetime.tzinfo indexing and “tzinfo” attribute links
2016-04-01 21:48:24 +00:00
cb7fff5ee3
Added a cookbook recipe for a logging context manager.
2016-04-01 23:06:57 +01:00
838b1339e8
Remove redundant leading zeroes in PEP references.
2016-03-31 15:31:04 +03:00
127f0d85e4
Issue #15660 : Further clarify 0 prefix for width specifier in formats.
2016-03-20 21:05:50 -04:00
dbcd457624
Issue #23857 : Implement PEP 493
...
Adds a Python-2-only ssl module API and environment variable to
configure the default handling of SSL/TLS certificates for
HTTPS connections.
2016-03-20 22:39:15 +10:00
3a4bdb6322
#26250 : document the sqlite3.Cursor.connection attribute. Initial patches by Aviv Palivoda and Varpu Rantala.
2016-03-18 20:10:36 +02:00
aac1dd0429
#24918 : fix CSS for code blocks when a side box is present. Patch by Manvi B.
2016-03-13 11:42:05 +02:00
6066257c38
#25687 : clarify that errors in tearDown increase the total number of reported errors. Initial patch by HyeSoo Park.
2016-03-13 09:40:09 +02:00
3d3a8f6c7b
#26247 : document Chrome/Chromium addition to webbrowser. Patch by Manvi B.
2016-03-11 21:32:12 +02:00
498834b7b9
Fix inspect.ismethod() doc
...
Closes #16851 : Fix inspect.ismethod() doc, return also True if object is an
unbound method.
Patch written by Anna Koroliuk.
2016-03-11 11:27:46 +01:00
69b7f812fa
Issue #15068 : Got rid of excessive buffering in the fileinput module.
...
The bufsize parameter is no longer used.
2016-03-08 18:35:45 +02:00
69d7f6a6a7
Issue #26505 : Fix typos in getaddrinfo license text.
...
Patch by Alex Willmer.
2016-03-07 14:51:19 -05:00
2ec5fd546f
Document another recipe for itertools: all_equal(). Inspired by David Beazley.
2016-03-06 18:06:29 -08:00
e41dc4f7bc
Issue #26485 : Fix Sphinx warning in Doc/license.rst
...
Patch by Julien.
2016-03-05 13:55:04 +02:00
deffc0be4b
issue26484 - fix the broken table in the doc about len().
2016-03-04 16:32:36 -08:00
bb569362f4
Issue #26246 : Set initial value of the hidden attr when creating copy button.
...
Patch by Liang-Bo Wang.
2016-03-02 19:44:24 +02:00
97b6e0bd1b
Fix typo.
2016-02-28 21:09:36 +01:00
5a3e8e5bc0
Issue 13573: Document that csv.writer uses str() for floats instead of repr().
2016-02-27 23:34:54 -08:00
ef85a1ac15
Issue #22836 : Keep exception reports sensible despite errors
2016-02-28 00:18:43 +00:00
f9ce84b195
#26246 : update copybutton.js after JQuery update. Patch by Liang-Bo Wang.
2016-02-27 08:39:36 +02:00
a575839f25
Fix rstlint to also look for indented comments that should be directives.
2016-02-25 20:14:10 +01:00
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
be9ddc1d11
Issue #26261 : Clarify NamedTemporaryFile name attribute vs file.name
2016-02-22 10:10:00 +00:00
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
35bb78ef7b
Added simple threading example to logging cookbook.
2016-02-20 19:02:04 +00:00
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
d6dd0e6560
Closes #20169 : fix inner links random doc.
2016-02-19 08:57:23 +01:00
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
51b13e53fc
fix typo ( closes #26378 )
2016-02-17 23:42:46 -08:00
c665ff6177
Closes #26320 : fix stylesheet after Sphinx update.
2016-02-10 13:44:29 +01:00
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
2dafcc25a9
Issues #26310 , #26311 : Fix typos in the documentation
2016-02-10 01:17:51 +00:00
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
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
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
9c61f2e45b
Fix userinfo example presented in urllib2 howto.
2016-02-05 19:35:57 -08:00
bf3b89782f
Python for .NET has moved to Github.
...
Reported by Denis Akhiyarov on docs@
2016-02-03 22:05:46 -06:00
1d269c1067
Issue #26244 : Clarify default zlib compression level in documentation
...
Based on patch by Aviv Palivoda.
2016-02-03 07:06:33 +00:00
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
b031adcd51
Fix typo in test.rst
...
Reported by Mike Scalora on docs@p.o.
2016-01-25 08:24:57 +02:00
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
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
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
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
762d761d65
issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs.
2016-01-20 03:18:48 -08:00
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
e57c957ff9
Issue26142 - Fix a formatting bug in c-api intro doc.
2016-01-17 17:05:14 -08:00
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
264dcb7290
Issue #26127 : Fix links in tokenize documentation
2016-01-16 04:32:52 +00:00
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
4cb7fca89f
#25574 : backport glossary doc fix about hash and id of user-defined classes.
2016-01-12 11:36:25 +02:00
7f62062be1
#19006 : fix wording in unittest docs.
2016-01-12 11:03:10 +02:00
50ba447ab7
#25517 : fix regex in the regex howto. Patch by Elena Oat.
2016-01-12 00:07:23 +02:00
167c336725
#25991 : fix readline example to limit history size. Patch by Daniel Dye.
2016-01-11 23:30:15 +02:00
c2ccb73e8a
delete old crypto prose ( closes #26066 )
2016-01-09 23:55:47 -08:00
145b1c6c2a
Issue23675 - A tiny clarification in the MRO glossary term.
2016-01-09 22:36:13 -08:00
ee98860e5f
Issue20969 - Set the Epub Author and Epub Publisher in Python docs.
2016-01-08 01:05:57 -08:00
c6fa90c7ca
fix typo in unittest docs ( closes #26046 )
...
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
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
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
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
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
fa45a0e3d2
Fix grammar.
...
Reported by Anatoly Techtonik on docs@
2016-01-01 12:22:16 -06:00
f30bad284b
remove some copyright notices supserseded by the toplevel ones
2016-01-01 11:53:47 -06:00
1f40ece2d7
2016 will be another year of writing copyrighted code
2016-01-01 10:23:45 -06:00
d77fe94b4e
Issue #22088 : Port base64 character ignoring doc and test from 857d9fe60169
2015-12-14 03:41:59 +00:00
edd6a817d1
Issue #20837 : Base-64 alphabet clarification from revision 1853679c6f71
2015-12-14 02:54:40 +00:00
b75adccd0a
#25495 : Clarify b2a_base64 documentation vis 57 bytes.
2015-12-13 18:04:14 -05:00
6b93ca6a3b
Clarify that only *documentation* bugs should go to docs@python.org
2015-12-09 01:53:44 -06:00
c9625c8e4b
Issue #25508 : Clarify documentation on LogRecord args attribute.
2015-11-24 23:18:30 +00:00
402803b642
Issue #23200 : Document that max_length=0 is not supported
2015-11-18 00:59:17 +00:00
793ae0d0ae
Issue #20468 : Remove incorrect information about maxrss and page size
...
Extract of patch by Ronald Oussoren.
2015-11-17 22:13:47 +00:00
a5d1cf3221
Issue #25615 : Document unsorted behaviour of glob; patch by Dave Jones
2015-11-16 23:46:22 +00:00
5118f7b9af
Issue #25017 : Document that htmllib is superseded by module HTMLParser
2015-11-14 00:30:46 +00:00
c0fdd825c2
Issue #25605 : Document exceptions raised by fcntl.ioctl() and fcntl.flock()
2015-11-13 09:13:16 +01:00
db7a1d6e15
Document the BUILD_SET opcode.
...
Reported by Hrvoje Abraham on docs@.
2015-11-12 10:02:06 -06:00
77d61d4156
Rewrite re.VERBOSE section.
...
It now has slightly better rationale and a less awkward wording in the
explanation.
Inspired by a report of a neither/or conflict by 'animalize' on docs@.
2015-11-11 23:32:14 -06:00
2ee55f37c2
Fix use of default reST role
2015-11-05 10:28:18 -06:00
be038077fb
remove trailing ws
2015-11-03 22:43:31 -08:00
40559cedb5
merge heads
2015-11-03 22:42:08 -08:00
873cad2f16
link to modern PUG url
2015-11-03 22:42:02 -08:00
c72e66a048
Issue #25523 : Backported a-to-an corrections.
2015-11-02 15:06:09 +02:00
a5ad9da504
Issue #25519 : Mark difflib.ndiff as a functions where not already.
2015-10-30 19:41:10 -04:00
0a1ba70949
Issue #25432 : Explain isinstance behaviour when type is a tuple.
2015-10-28 03:14:46 -04:00
15a43ed030
Issue #25461 : Rephrase os.walk() doc
...
Patch written by Bernt Røskar Brenna.
2015-10-23 12:42:39 +02:00
63173a8c7e
Added entry to logging cookbook.
2015-10-17 13:55:19 +01:00
1c49ec0df0
Issue #24782 : Finish converting the Configure Extension dialog into a new
...
tab in the IDLE Preferences dialog. Code patch by Mark Roseman.
2015-10-13 22:03:44 -04:00
a20c72a264
actually link to the version attributes documentation
2015-10-11 23:03:22 -07:00
d2a19c2c67
don't mention Python 2.2 ( closes #25375 )
2015-10-10 23:23:55 -07:00
4ed35fc4f3
Issue #25161 : Add full stops in documentation; patch by Takase Arihiro
2015-10-10 10:52:35 +00:00
dab305ef05
Issue #22413 : Document newline effect on StringIO initializer and getvalue
...
Also add to comment in the C code.
2015-10-10 02:52:30 +00:00
9918775206
Closes #25344 : Added cookbook recipe to show buffering of logging events.
2015-10-10 00:49:10 +01:00
840c82ee88
Issue #25286 : Accidentally dropped "the"
2015-10-07 10:39:13 +00:00
4a33724d47
Issue #25286 : Dictionary views are not sequences
...
Also change glossary heading from "view" to "dictionary view". Patch by Akira
Li.
2015-10-07 10:19:39 +00:00
fcf58a1518
Issue #16701 : Document += and *= for mutable sequences
2015-10-03 07:37:22 +00:00
195fc2f2aa
Issue #25224 : README.txt is now an idlelib index for IDLE developers and
...
curious users. The previous user content is now in the IDLE doc and is
redundant. IDLE now means 'Integrated Development and Learning Environment'.
2015-10-02 23:22:54 -04:00
958a9c7520
Issue #24028 : Add subsection about Idle calltips.
2015-09-29 01:55:50 -04:00
02dc7d1272
merge heads
2015-09-27 02:08:04 -07:00
9fa7e2e5ef
Fix broken link in Doc/extending/index.rst
2015-09-27 12:06:26 +03:00
4e648f6c07
make wikipedia link https
2015-09-27 02:05:01 -07:00
9b4865ad2b
shorten and fix casing of title
2015-09-27 01:23:10 -07:00
f56f8d1800
Issue #25225 : Condense and rewrite Idle doc section on text colors.
2015-09-24 23:13:43 -04:00
7cca4e5ba2
Issue 21995: Explain some differences between IDLE and console Python.
2015-09-24 03:09:38 -04:00
68dafe5f14
Issue #24894 : Document the codec iso8859_11
...
Patch written by Prashant Tyagi.
2015-09-24 09:05:19 +02:00
cf5bf82e59
Issue #22820 : Explain need for *print* when running file from Idle editor.
2015-09-24 01:39:25 -04:00
6741a5ae19
Issue 25224: Augment Idle doc feature list and no-subprocess section
...
to finish making current README.txt obsolete.
2015-09-23 20:00:22 -04:00
c7025c6265
Issue #25219 : Update doc for Idle command line options.
...
Some were missing and notes were not correct.
2015-09-23 03:52:18 -04:00
0612ae52a0
Issue #23484 : Document differences between synchronization primitives of
...
threading and multiprocessing modules.
In multiprocessing, the name of the first parameter of the acquire methods is
"block", but "blocking" in threading.
This commit also improves documentation of Lock and RLock.
Patch by Davin Potts.
2015-09-21 07:15:52 +03:00
1b822d0e2f
use a more modern UA ( #25145 )
2015-09-20 23:16:45 +05:00
c717e08720
remove reference to PyGoogle ( #25145 )
...
Patch by Bar Harel.
2015-09-20 23:17:41 +05:00
b85154fa37
Issue24756: clarify usage of run_docstring_examples()
2015-09-17 22:19:48 -07:00
061653091e
fix name of argument in docstring and the docs ( closes #25076 )
...
Patch by TAKASE Arihiro.
2015-09-12 17:20:47 -07:00
9b2e37f688
Marked keystrokes with the :kbd: role.
...
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:47:12 +03:00
b2528c92f1
Issue #16473 : Fix byte transform codec documentation; test quotetabs=True
...
This changes the equivalent functions listed for the Base-64, hex and Quoted-
Printable codecs to reflect the functions actually used. Also mention and
test the "quotetabs" setting for Quoted-Printable encoding.
2015-09-12 00:34:28 +00:00
d0384044ee
Fix grammatical error in csv docs.
...
Reported by Nat Dunn on docs@
2015-09-11 10:51:47 -05:00
6f80464f4a
Issue #25030 : Do not document seek() as if it accepts keyword arguments
...
Patch from Shiyao Ma.
2015-09-11 03:58:30 +00:00
Mariatta
Nick Coghlan
cocoatomo
Eric Wieser
INADA Naoki
Mandeep Singh
Senthil Kumaran
Xiang Zhang
Qingpeng "Q.P." Zhang
Mariatta Wijaya
Martin Panter
Senthil Kumaran
Alexander Belopolsky
Berker Peksag
Raymond Hettinger
Benjamin Peterson
Ned Deily
Brett Cannon
Victor Stinner
Serhiy Storchaka
Terry Jan Reedy
Guido van Rossum
Vinay Sajip
R David Murray
Christian Heimes
Zachary Ware
Georg Brandl
Tommy Beadle
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)
Donald Stufft
Eli Bendersky
Ezio Melotti
Ethan Furman
Martin Panter