Xiang Zhang
58c2c6ebb8
Issue #29078 : Add the missing import in datetime.time doc example.
...
Patch by Dhushyanth Ramasamy.
2016-12-27 12:21:28 +08:00
Martin Panter
427ca62dde
Issue #1446619 : Account for negative slice direction in description
...
Based on suggestion from Fumihiro Bessho.
2016-12-24 08:25:15 +00:00
Martin Panter
3698bd262f
Issue #29004 : Document binascii.crc_hqx() implements CRC-CCITT
2016-12-24 07:53:57 +00:00
Ned Deily
c04957531e
Update documentation index sidebar for 3.6.0 release.
2016-12-23 04:12:46 -05:00
Xiang Zhang
c4f91baa35
Issue #29038 : Fix duplicate get_ca_certs() doc entry.
2016-12-23 11:10:19 +08:00
Brett Cannon
00ebffe5e1
Grammatical fixes for d95f19892fd0
2016-12-22 10:03:11 -08:00
Victor Stinner
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
Brett Cannon
37eb788e9e
Update the porting HOWTO
2016-12-17 12:38:54 -08:00
Serhiy Storchaka
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
Martin Panter
3eb92e06df
Issue #28916 : No special case for leading zeros with %x alternative form
2016-12-11 03:51:44 +00:00
Ned Deily
3797922ad9
Issue #28900 : Update documentation sidebar for 3.6.0rc.
2016-12-07 23:34:23 -05:00
Serhiy Storchaka
8b5528782a
Fixed mismatching title overline.
2016-12-04 15:42:13 +02:00
Serhiy Storchaka
e7f555b969
Fixed double hyphens that are rendered to literal en-dashes in the documenation.
2016-12-04 10:20:18 +02:00
Ned Deily
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
Serhiy Storchaka
1ae56fb9ee
Issue #21818 : Fixed references to classes that have names matching with module
...
names.
2016-12-02 23:13:42 +02:00
Martin Panter
b398d2c2bf
Issue #28771 : Correct documentation of signatures using const
2016-12-01 01:32:16 +00:00
Martin Panter
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
Martin Panter
a52b567a3f
Issue #28820 : Fix spelling of “practice” as a noun
2016-11-30 10:18:45 +00:00
Serhiy Storchaka
0092bc7279
Issue #28763 : Use double hyphens (rendered as en-dashes) in numerical ranges
...
in the documentation.
2016-11-26 13:43:39 +02:00
Serhiy Storchaka
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
Martin Panter
3738ef4294
Change double hyphens (en dashes) to em (longer) dashes
2016-11-21 00:21:39 +00:00
Serhiy Storchaka
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
Terry Jan Reedy
fed0883e94
Issue #28615 : Backport imaginary/complex number text from 3.x.
...
Patch by Mariatta Wijaya.
2016-11-11 19:09:50 -05:00
Martin Panter
b26a7d18ef
Fix spacing after C++ in documentation
2016-11-05 03:15:20 +00:00
Serhiy Storchaka
b858d7f074
Issue #28513 : Documented command-line interface of zipfile.
2016-11-02 12:05:54 +02:00
Martin Panter
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
Martin Panter
e3e362e398
Issue #26638 : Mask undefined CLI options to defeat new Sphinx warnings
2016-10-30 05:19:02 +00:00
Martin Panter
ee01fccc69
Issue #26638 : Disable inappropriate links to Python interpreter options
2016-10-30 05:24:45 +00:00
Serhiy Storchaka
f831fd3f19
Issue #22949 : Documented that fnmatch.translate() is for use with re.match().
2016-10-27 22:47:08 +03:00
Serhiy Storchaka
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
Serhiy Storchaka
cb042e0448
Issue #19795 : Fixed formatting a table.
2016-10-19 19:37:20 +03:00
Serhiy Storchaka
dc0e3a8907
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:30:16 +03:00
Serhiy Storchaka
e3d5787a25
Issue #19795 : Mark up True and False as literal text instead of bold.
2016-10-19 16:43:18 +03:00
Serhiy Storchaka
ad13f338ce
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:10 +03:00
Victor Stinner
5df6d48ce5
Issue #27896 : Allow passing sphinx options to Doc/Makefile
...
Patch written by Julien Palard.
2016-10-16 19:14:23 +02:00
Martin Panter
197332ae5a
Issue #27800 : Document limitation and workaround for multiple RE repetitions
2016-10-15 01:18:16 +00:00
Guido van Rossum
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
Serhiy Storchaka
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
Terry Jan Reedy
dace77c530
Issue #28815 : Change '?' to '<module>' in some doc examples.
...
Patch by Mariatta Wijaya.
2016-09-30 15:38:41 -04:00
Berker Peksag
6f959d07db
Issue #26550 : Fix typo in webservers HOWTO
...
Reported by Alejandro Soini.
2016-09-29 02:32:51 +03:00
Martin Panter
de2d4d2048
Issue #26439 : Document that RTLD_NOW is always added
2016-09-27 05:10:40 +00:00
Ned Deily
47f190a072
Make 3.7 the current dev version in the html version of the docs.
2016-09-20 14:58:38 -04:00
Raymond Hettinger
84a449abb3
Issue #28104 : More accurately document set method signatures
2016-09-12 23:43:03 -07:00
Terry Jan Reedy
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
Raymond Hettinger
63c79966d5
Issue #26557 : Note that mapping view methods are not present in UserDict or shelves.
2016-09-11 20:38:27 -07:00
Vinay Sajip
0954ac1b5c
Issue #23105 : Updated documentation on open() flag constants.
2016-09-11 15:11:50 +01:00
Martin Panter
fcc8a0f0f5
Correct spelling in documentation and code comments
2016-09-10 10:38:28 +00:00
Martin Panter
ba5480b656
Issue #27993 : Fix problems with the plural “objects” in docs and comments
2016-09-08 05:39:59 +00:00
R David Murray
039f184654
#26209 : Clarify type of *localaddr*/*remoteadr* in smtpd docs.
2016-09-07 14:09:51 -04:00
Christian Heimes
4e64c2c838
Fix ssl documentation and remove merge accident
2016-09-06 23:41:37 +02:00
Christian Heimes
d988f429fe
Issues #27850 and #27766 : Remove 3DES from ssl default cipher list and add ChaCha20 Poly1305.
2016-09-06 20:06:47 +02:00
Christian Heimes
c2fc7c4f53
Issue #26470 : Port ssl and hashlib module to OpenSSL 1.1.0.
2016-09-05 23:37:13 +02:00
Raymond Hettinger
56c5152370
Issue #27706 : Document that random.seed() is non-deterministic when PYTHONHASHSEED is enabled
2016-08-31 14:57:32 -07:00
Terry Jan Reedy
580ca656bd
Backport spelling fix.
2016-08-30 16:57:53 -04:00
Serhiy Storchaka
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
Terry Jan Reedy
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
Martin Panter
99496760c7
Fix some spelling errors
2016-08-20 08:00:53 +00:00
R David Murray
4ae4e7cbc0
#27753 : fix typo (name->named).
2016-08-13 14:46:23 -04:00
Raymond Hettinger
af0b38f814
Issue #27720 : Fix error in eng_to_decimal docs and add examples from the specification.
2016-08-13 11:10:23 -07:00
Zachary Ware
fa1ce08fc6
Issue #27205 : Fix doctests in Doc/library/collections.rst
2016-08-09 17:28:33 -05:00
Zachary Ware
d379d6377f
Issue #27204 : Fix doctests in Doc/howto
...
Initial patch by Jelle Zijlstra.
2016-08-09 17:03:32 -05:00
Martin Panter
8f1dd224e0
Issue #26462 : Doc: avoid literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Senthil Kumaran
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
Martin Panter
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
Martin Panter
e2eacc02bc
Issue #23943 : Fix typos. Patch by Piotr Kasprzyk.
2016-07-28 03:04:04 +00:00
Zachary Ware
2955ef759e
Issue #25393 : Fix probable copy/paste error in resource docs
...
Patch by Alakshendra Yadav.
2016-07-19 16:41:20 -05:00
Martin Panter
cdb8be4f40
Issue #27528 : Document and test warning messages must match at beginning
2016-07-19 02:26:38 +00:00
Martin Panter
bf2dca96fb
English spelling and grammar fixes
2016-07-11 07:51:37 +00:00
Martin Panter
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
Serhiy Storchaka
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
Victor Stinner
bc44893155
Issue #27416 : clarify copy doc
...
Patch written by R. David Murray.
2016-06-30 11:50:23 +02:00
Martin Panter
aaa4baf4e5
Issue #27370 : Use t for an iterable in mutable sequence ops
2016-06-23 00:53:05 +00:00
Senthil Kumaran
8da85a173a
Fix the urllib.parse.urljoin docs. Reported by Bo Bayles in docs list.
2016-06-22 00:56:22 -07:00
Martin Panter
4e6e565368
Fix English spelling and grammar errors
2016-06-20 07:52:50 +00:00
Serhiy Storchaka
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
Martin Panter
d51b0f2188
Issue #24314 : Add links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
Georg Brandl
b311eeefb8
Docs: add html-stable autobuild variant
2016-06-15 08:57:32 +02:00
Martin Panter
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
Martin Panter
fc0a55fed9
Issue #16182 : Backport documentation of set_pre_input_hook() availability
2016-06-14 08:45:43 +00:00
Berker Peksag
0d8657721e
Issue #15657 : Delete incorrect statement from PyMethodDef documentation
2016-06-12 16:37:57 +03:00
Martin Panter
056cbfdc51
Fix typo in documentation
2016-06-12 06:14:03 +00:00
Martin Panter
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
Martin Panter
be2bb472b0
Issue #16484 : PYTHONDOCS still uses “http:” in Python 2
2016-06-12 04:38:34 +00:00
Tommy Beadle
33b19ca77f
Issue #24617 : Add comment for os.mkdir about mode quirks
2016-06-02 15:41:20 -04:00
Martin Panter
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
Martin Panter
d6cecd30af
Issue #8491 : Add link to Gnu Readline configuration documentation
2016-06-10 00:27:46 +00:00
Tommy Beadle
24b9e1a00d
[Issue 15476] Make "code object" its own entry in the index
2016-06-02 19:26:51 -04:00
Martin Panter
d5982d0433
Issue #23275 : Backport empty square bracket assignment documentation fix
2016-06-08 12:44:30 +00:00
Martin Panter
6af1c49bb4
Issue #25738 : Don’t send message body for 205 Reset Content
...
Patch by Susumu Koshiba.
2016-06-08 07:16:14 +00:00
Ned Deily
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
Ned Deily
06cd1c3d36
Issue 27216: Fix typo (noticed by Alex Chan).
2016-06-04 09:39:42 -07:00
Senthil Kumaran
e6167e33e6
[backport to 2.7] - issue8519 - Reference termios and ioctl manual pages in the library documentation.
2016-06-02 23:51:22 -07:00
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)
c3cd60e764
issue25931: document that socketserver.Forking* are unavailable on platforms
...
that support os.fork.
2016-06-03 05:48:23 +00:00
R David Murray
3017cef009
#13784 : fix xml.sax.reader getColumn/LineNumber docs.
...
verification and patch by Emily Morehouse.
2016-06-02 15:13:37 -04:00
Benjamin Peterson
382d041131
note that Py_VISIT handles NULL ( closes #27183 )
2016-06-02 11:35:59 -07:00
Berker Peksag
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
Martin Panter
fcd7d34afb
Issue #25570 : Add example of customizing User-Agent via add_header()
2016-06-01 08:20:22 +00:00
Martin Panter
200a615774
Issue #27125 : Remove duplicated words from documentation and comments
2016-05-30 04:04:50 +00:00
Senthil Kumaran
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
Martin Panter
b44c4520d9
Issue #27125 : Fix various errors like “will [be] inherited”
2016-05-29 08:13:58 +00:00