Commit Graph

25 Commits

Author SHA1 Message Date
CAM Gerlach 31fa41ed68
gh-92611: Clarify planned removal version in PEP 594-deprecated modules (GH-92793)
As discussed in #92611 and #92564 and as a followup to PR #92612 , this 3.11+ only PR uses the proper `deprecated-removed` role for the modules deprecated by PEP 593 (PEP-594) to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts.

Related to #92792 ; if we decide to backport that PR, the upgrade to using `deprecated-removed` on those functions can be moved to this one.
2022-05-20 14:47:51 -07:00
CAM Gerlach 9f68dab3d3
gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 12:54:12 -07:00
Brett Cannon 9ac2de922a
bpo-47061: document module deprecations due to PEP 594 (GH-31984)
Also removed asynchat, asyncore, and smtpd from their respective toctree entries so they are only  in the superceded subtree.
2022-03-21 16:16:37 -07:00
Victor Stinner d3ded08048
bpo-40204: Add :noindex: in the documentation (GH-21859)
Add :noindex: to duplicated documentation to fix "duplicate object
description" errors.

For example, fix this Sphinx 3 issue:

Doc/library/configparser.rst:1146: WARNING: duplicate object
description of configparser.ConfigParser.optionxform, other instance
in library/configparser, use :noindex: for one of them
2020-08-13 21:41:54 +02:00
Serhiy Storchaka 2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174) 2018-12-19 08:09:46 +02:00
Benjamin Peterson 5b79d60d2c remote note about IRIX in aifc (#3299)
This comment hasn't been true since Python 3.0.
2017-09-04 13:32:34 -07:00
Terry Jan Reedy fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
R David Murray cbf479ae64 whatsnew: sunau/aifc/wave writeframes[raw] accept any bytes-like (#8311) 2014-03-08 11:46:05 -05:00
R David Murray d592bb2dc4 whatsnew: afic.open supports 'with'. 2013-12-31 13:45:38 -05:00
Serhiy Storchaka 452bab4acf Issue #16685: Added support for writing any bytes-like objects in the aifc,
sunau, and wave modules.
2013-11-16 14:01:31 +02:00
Georg Brandl 1a51b558a5 Simplify markup. 2013-10-21 09:07:31 +02:00
Serhiy Storchaka ef23f1875d Fix markup. 2013-10-18 11:55:30 +03:00
Serhiy Storchaka 335331311f Fix markup. 2013-10-18 11:55:02 +03:00
R David Murray c91d5eea10 #17616: wave.open now supports the 'with' statement.
Feature and tests by ClClaudiu.Popa, I added the doc changes.
2013-07-31 13:46:08 -04:00
R David Murray 4d35e75ca0 #17818: aifc.getparams now returns a namedtuple.
Patch by Claudiu Popa.
2013-07-25 16:12:01 -04:00
Serhiy Storchaka 44c66c72c9 Issue #16486: Make aifc files work with 'with' as context managers. 2012-12-29 22:54:49 +02:00
Raymond Hettinger ead4975b9f Missing source links. 2011-01-24 16:28:06 +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 502d9a5c2c Merged revisions 74207 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r74207 | georg.brandl | 2009-07-26 16:19:57 +0200 (So, 26 Jul 2009) | 1 line

  #6577: fix (hopefully) all links to builtin instead of module/class-specific objects.
........
2009-07-26 15:02:41 +00:00
R. David Murray e08a66a371 Document the fact that 'compname' and 'comptype' are bytes. 2009-04-29 21:50:39 +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
Georg Brandl b868a66ccb First batch of signature documentation changes; using default argument syntax where applicable. 2009-04-02 02:56:10 +00:00
Georg Brandl 48310cd3f2 Remove trailing whitespace. 2009-01-03 21:18:54 +00:00
Guido van Rossum da27fd2673 Manually patched a few things that didn't get merged in, but should. 2007-08-17 00:24:54 +00:00
Georg Brandl 116aa62bf5 Move the 3k reST doc tree in place. 2007-08-15 14:28:22 +00:00