d378b1f8ed
bpo-34764: improve docs example of iter() with sentinel value (GH-11222)
2018-12-23 21:07:17 -08:00
fc8284e220
bpo-35564: add master_doc='contents' to conf.py (GH-11290)
2018-12-22 23:31:08 +01:00
b912f9342e
bpo-35511: Trivial docs updates for profile and resource library modules. (GH-11124)
...
polish documentation for profile and resource modules
2018-12-16 21:34:08 +02:00
361e8683e7
bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023)
...
I'll watch for 404 on the old URL and will setup an HTTP redirection if needed.
2018-11-21 13:41:07 +01:00
64313478bc
bpo-32613: Update window FAQ (GH-5552)
2018-11-14 16:22:27 +01:00
55f3317e98
bpo-10536: Enhancements to gettext docs (GH-10324)
2018-11-04 23:24:41 +01:00
3f819ca138
bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)
2018-10-31 02:26:06 +02:00
c8a8d6b347
bpo-35089: Don't mention typing.io and typing.re (GH-10173)
...
https://bugs.python.org/issue35089
2018-10-28 16:03:29 +00:00
12e696b4f0
bpo-35042: Use the :pep: role where a PEP is specified ( #10036 )
2018-10-26 15:58:26 -07:00
e483f02423
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
2018-10-26 12:52:11 +02:00
1770d1c512
bpo-35038: AttributeError: 'frame' object has no attribute 'f_restricted'. (GH-10098)
...
https://bugs.python.org/issue35038
2018-10-25 14:13:45 -07:00
ded87d804e
bpo-33594: Add deprecation info in inspect.py module (GH-7036)
2018-10-20 01:40:45 +02:00
e385d0661e
bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
2018-10-13 08:14:08 +02:00
2d6097d027
bpo-11233: Create availability directive for documentation (GH-9692)
...
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
2018-10-12 16:55:20 +02:00
7c817e620b
bpo-34913: Document gzip command line interface (GH-9782)
2018-10-10 08:28:26 +02:00
6261ae9b01
bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)
...
Let .chm document display non-ASCII characters properly
Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems.
2018-10-08 14:20:54 -07:00
683281f536
bpo-34906: Doc: Fix typos (2) (GH-9735)
...
Fix typos
2018-10-06 16:35:53 +02:00
996859a90d
bpo-34790: [docs] Passing coroutines to asyncio.wait() can be confusing. (GH-9543)
2018-09-25 14:51:21 -04:00
a0fd7f1b55
Migrate datetime.date.fromtimestamp to Argument Clinic (GH-8535)
2018-09-24 10:39:02 +02:00
1aeba7458d
bpo-34552: Clarify built-in types comparisons (GH-9035)
...
Some updates to ancient text about comparisons; fixes bp-34552.
2018-09-13 21:50:18 -07:00
731ff68eee
closes bpo-25041: Document AF_PACKET socket address format. (GH-4092)
2018-09-11 17:32:15 -07:00
08bcf647d8
bpo-28617 Fixed docs inaccuracies about the types that support membership tests (GH-9086)
...
<!-- issue-number: [bpo-28617](https://www.bugs.python.org/issue28617 ) -->
https://bugs.python.org/issue28617
<!-- /issue-number -->
2018-09-11 10:44:52 -07:00
ffa198c642
bpo-33487: improve BZ2File Deprecation and documentation. (GH-6785)
...
Emit warning when None passed explicitly, list Python version since
deprecation in warning message and docs.
2018-09-10 18:15:56 -07:00
f019579828
bpo-33460: remove ellipsis that look like continuation prompts (GH-7851)
...
Remove ellipsis that look like continuation prompts,
has a side benefit of putting rest of error message in proper text color.
2018-09-10 18:13:08 -07:00
2800dcf656
bpo-34065: Improve the markup of logging.basicConfig() arguments (GH-8153)
2018-07-07 15:36:40 +03:00
695118600f
bpo-33847: Add '@' operator entry to index (GH-7669)
2018-06-15 15:23:00 -04:00
9e7c92193c
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413)
...
The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
ef24b6c54d
bpo-31432: Clarify ssl CERT_NONE/OPTIONAL/REQUIRED docs. (GH-3530)
...
The documentation for CERT_NONE, CERT_OPTIONAL, and CERT_REQUIRED were
misleading and partly wrong. It fails to explain that OpenSSL behaves
differently in client and server mode. Also OpenSSL does validate the
cert chain everytime. With SSL_VERIFY_NONE a validation error is not
fatal in client mode and does not request a client cert in server mode.
Also discourage people from using CERT_OPTIONAL in client mode.
2018-06-11 18:59:45 -04:00
1bcb8a6368
bpo-33409: Clarify PEP 538/540 relationship (GH-7534)
...
While locale coercion and UTF-8 mode turned out to
be complementary ideas rather than competing ones,
it isn't immediately obvious why it's useful to
have both, or how they interact at runtime.
This updates both the Python 3.7 What's New doc
and the PYTHONCOERCECLOCALE and PYTHONUTF8
documentation in an attempt to clarify that
relationship:
- in the respective What's New sections, add a closing paragraph
explaining which problem each one solves, and pointing to the
other PEP's section for the specific aspects it relies on the other
PEP to solve
- use "locale-aware mode" as a more descriptive term for the
default non-UTF-8 mode
- improve wording conistenccy between the PYTHONCOERCECLOCALE
and PYTHONUTF8 docs when they cover the same thing (mostly
related to legacy locale detection and setting the standard
stream error handler)
- improve the description of the locale coercion trigger conditions
(including pointing out that setting LC_ALL turns off locale coercion)
- port the full description of the UTF-8 mode behaviour changes
from PEP 540 into the PYTHONUTF8 documentation
- be explicit that PYTHONIOENCODING still overrides the settings
for the standard streams
- mention concrete examples of things that do and don't get their
text encoding assumptions adjusted by the two text encoding
assumption override techniques
2018-06-09 16:54:08 +10:00
4f54867e29
bpo-33197: Add versionadded tag to the documentation of ParameterKind (GH-7536)
2018-06-08 12:07:52 -04:00
c0d062f523
bpo-33736: Improve the documentation of asyncio stream APIs (GH-7326)
2018-06-08 11:36:00 -04:00
f9aeca2085
bpo-23859: Document that asyncio.wait() does not cancel its futures ( #7217 )
...
Unlike `asyncio.wait_for()`, `asyncio.wait()` does not cancel the passed
futures when a timeout accurs.
2018-05-29 18:21:44 -04:00
28b9178023
bpo-32436: Document PEP 567 changes to asyncio. (GH-7073)
2018-05-23 13:35:04 -04:00
8bb0b5b03c
bpo-33604: Remove Pending from hmac Deprecation warning. (GH-7062)
...
bpo-33604: Bump removal notice from 3.6 to 3.8 and change PendingDeprecationWarning to DeprecationWarning as we had intended to do earlier...
2018-05-22 15:55:31 -07:00
19177fbd5d
bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814)
2018-05-15 14:58:35 -04:00
b7b493e2fb
Add AsyncContextManager to typing module documentation. (GH-6822)
2018-05-14 18:14:07 -04:00
7508a54c77
bpo-20709: os.utime(path_to_directory): wrong documentation for Windows. (GH-5469)
...
Remove the paragraph where we explain that os.utime() does not support a
directory as path under Windows. Patch by Jan-Philip Gehrcke
Co-authored-by: Jan-Philip Gehrcke <jgehrcke@gmail.com>
2018-05-01 12:02:26 +02:00
5779483299
bpo-33378: Add Korean to the language switcher. (GH-6627)
2018-04-28 22:08:22 +02:00
441d945eb3
Clarify that __path__ can't be just any value (GH-6554)
2018-04-20 16:32:46 -07:00
1d80a56173
bpo-33201: Modernize "Extension types" doc (GH-6337)
...
* bpo-33201: Modernize "Extension types" doc
* Split tutorial and other topics
* Some small fixes
* Address some review comments
* Rename noddy* to custom* and shoddy to sublist
* Fix markup
2018-04-07 18:14:03 +02:00
ef5ce884a4
bpo-8243: Doc patch for curses.window.addstr and curses.window.addch (GH-5179)
2018-04-06 21:27:07 -04:00
42ec190761
bpo-33195: Doc: Deprecate Py_UNICODE in c-api/arg (GH-6329)
...
Py_UNICODE is deprecated since Python 3.3.
But the deprecation is missed in the c-api/arg document.
2018-04-04 13:59:08 +09:00
dfbbbf16f9
bpo-32337: Update documentats about dict order (GH-4973)
2018-04-04 13:55:05 +09:00
aa50bf08e6
bpo-33126: Document PyBuffer_ToContiguous() ( #6292 )
2018-03-28 17:26:32 +02:00
da1734c58d
bpo-27212: Modify islice recipe to consume initial values preceding start (GH-6195)
2018-03-26 18:29:33 -07:00
5cbb84106e
bpo-27428: Fix WindowsRegistryFinder documentation to list appropriate ABC (GH-6061)
2018-03-23 14:26:35 -07:00
5609b78392
bpo-18802: Add more details to ipaddress documentation (GH-6083)
...
Original patch by Jon Foster and Berker Peksag.
2018-03-21 08:09:15 +08:00
4be79f2946
bpo-28247: Document Windows executable creation in zipapp (GH-6158)
2018-03-20 22:23:19 +00:00
bf63e8d55f
bpo-30607: Use external python-doc-theme (GH-2017)
2018-03-01 16:02:50 -05:00
90f05a527c
bpo-28124: deprecate ssl.wrap_socket() ( #5888 )
...
The ssl module function ssl.wrap_socket() has been de-emphasized
and deprecated in favor of the more secure and efficient
SSLContext.wrap_socket() method.
Signed-off-by: Christian Heimes <christian@python.org>
2018-02-27 09:21:34 +01:00
186b606d8a
bpo-17232: Clarify docs for -O and -OO command line options ( #5839 )
...
The 'optimization' is for space in the executable file, not for run time.
2018-02-24 22:04:40 -05:00
dfa015cf77
bpo-31972: Improve docstrings for pathlib classes ( #5310 )
2018-02-18 18:36:32 -05:00
bd093355a6
bpo-32436: Add docs for contextvars ( #5685 )
2018-02-16 11:47:54 -05:00
988fb28431
bpo-11015: Update test.support documentation (GH-5610)
2018-02-11 23:10:42 +10:00
8d1f2f4038
bpo-32800: Update link to w3c doc for xml default namespaces (GH-5609)
...
The new link is given in a red box on the old page.
2018-02-10 17:39:43 -05:00
d1f318105b
bpo-8722: Document __getattr__ behavior with AttributeError in property (GH-4754)
...
When `__getattr__` is implemented, attribute lookup will always fall back to that,
even if the initial failure comes from `__getattribute__` or a descriptor's `__get__`
method (including property methods).
2018-02-05 12:03:22 +10:00
66771422d0
bpo-32614: Modify re examples to use a raw string to prevent warning (GH-5265)
...
Modify RE examples in documentation to use raw strings to prevent DeprecationWarning.
Add text to REGEX HOWTO to highlight the deprecation. Approved by Serhiy Storchaka.
2018-02-02 16:16:27 -05:00
ab328756d7
bpo-32722: Remove useless example in the Classes tutorial ( #5446 )
...
In the tutorial about the Generator expression, there is an example with
a dict comprehension and not with a generator expression, just removed
the code.
2018-02-01 15:31:07 +08:00
6e41cd95b5
Update NEWS, docs, and patchlevel for 3.7.0b1
2018-01-31 17:14:30 -05:00
67adb31a41
bpo-32724: Fix references to commands in Doc/pdb.rst (GH-5444)
...
Some commands are specified in the documentation, but there is no direct
references.
2018-01-30 11:34:33 +02:00
255f7a26da
bpo-32649: Add C API docs for per-opcode tracing & profiling (GH-5360)
...
Updating the C API docs was missed when the per-opcode
tracing & profiling support was initially added.
2018-01-28 19:53:38 +10:00
131fd7f96c
bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile ( #4056 )
2018-01-24 20:57:49 +08:00
3b43bfaae6
Update docs for 3.7.0a4
2018-01-08 21:57:13 -05:00
1634fc289a
bpo-32418: Add get_loop() method on Server, AbstractServer classes ( #4997 )
...
* Add abstract get_loop() method to Server, AbstractServer classes.
* Add test cases for get_loop() method in Server, AbstractServer classes
* Add documentation for get_loop() method
2017-12-30 17:09:32 +02:00
3f9a728d95
Update NEWS and pydoc topics.
2017-12-05 03:17:33 -05:00
431665bf19
bpo-32105: add asyncio.BaseEventLoop.connect_accepted_socket versionadded to documentation. ( #4491 )
2017-11-21 11:06:26 -05:00
c730223d18
Update NEWS and topics for 3.7.0a2
2017-10-16 23:41:55 -04:00
eeb5ffd54e
bpo-31537: Update readline documentation example. (GH-3925)
...
Change the code example from using `get_history_length` to `get_current_history_length`.
2017-10-10 14:52:58 -07:00
5b9299d8c7
bpo-30085: Improve documentation for operator ( #1171 )
...
The dunderless functions are preferred; dunder are retained for back compatilibity.
Patch by Sanket Dasgupta.
2017-09-24 14:29:22 -04:00
450ceea331
Update PyDoc topics and NEWS blurbs for 3.7.0a1
2017-09-19 01:01:36 -04:00
6a396c9807
bpo-31128: Allow pydoc to bind to arbitrary hostnames ( #3011 )
...
New -n flag allow overriding localhost with custom value,
for example to run from containers.
2017-09-14 17:54:09 -04:00
586c0502b5
bpo-31294: Fix ZeroMQSocketListener and ZeroMQSocketHandler examples ( #3229 )
...
* Fix ZeroMQSocketListener and ZeroMQSocketHandler examples
* Use send_json and recv_json to simplify pyzmq interfacing
* Add News entry
2017-09-07 13:53:13 -07:00
ad0ffa033e
bpo-21649: Add RFC 7525 and Mozilla server side TLS ( #3387 )
...
Signed-off-by: Christian Heimes <christian@python.org>
2017-09-06 16:19:56 -07:00
564a2c68ad
Link to blurb on PyPI in the NEWS.d READMEs. ( #3323 )
2017-09-05 10:38:05 -07:00
f9f17346d7
Blurbify master branch. ( #3298 )
...
Blurbify master branch.
2017-09-04 13:30:19 -07:00
caa1280d1e
bpo-30803: clarify truth value testing documentation ( #2508 )
...
Initial patch by Peter Thomassen.
2017-07-29 15:18:13 -04:00
ea007984d3
Add "Misc/NEWS.d" directory tree for "blurb". (GH-2316)
...
Add "Misc/NEWS.d" directory tree for "blurb".
CPython workflow is changing! We're going to start using "blurb"
to manage Misc/NEWS entries:
https://github.com/python/core-workflow
(This will be a big win for release managers, honest.)
This checkin simply populates the "Misc/NEWS.d" subdirectory tree
so that people can start putting their news entries in there.
No other changes (yet).
2017-06-22 10:29:02 -07:00
Chris Rands
Jean-François B
Beomsoo Kim
Zhiming Wang
Julien Palard
Stéphane Wirtel
Serhiy Storchaka
Sebastian Rittau
Matthias Bussonnier
Cheryl Sabella
animalize
Yury Selivanov
Tim Hoffmann
Windson yang
wim glenn
Lew Kurtz
Dong-hee Na
Andrés Delfino
Eric Snow
Christian Heimes
Nick Coghlan
Elvis Pranskevichus
Travis DePrato
Brett Cannon
Antoine Pitrou
Jay Crotts
INADA Naoki
hui shang
Himanshu Lakhara
Jon Wayne Parrott
chason
sblondon
Ned Deily
Xiang Zhang
Pablo Galindo
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)
AraHaan
Brad Smith
Sanket Dasgupta
Feanil Patel
Gregory P. Smith
larryhastings
Peter Thomassen