mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-31 14:07:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
123623 commits 7 branches 624 tags 2.5 GiB
Commit graph

178 commits

Author SHA1 Message Date
Wei-Hsiang (Matt) Wang
05dcc81601
[3.13] gh-123517: Remove unnecessary :meth: parentheses (gh-123518) (GH-123577) 2024-09-02 16:00:04 +02:00
Wei-Hsiang (Matt) Wang
9f5f2b7128
[3.13] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (#123513) 2024-08-30 20:14:48 +03:00
Miss Islington (bot)
c33bba6eb3
[3.13] docs: module page titles should not start with a link to themselves (GH-117099) (#118790) 
docs: module page titles should not start with a link to themselves (GH-117099)
(cherry picked from commit bcb435ee8f)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
 2024-05-08 19:52:39 +00:00
Skip Montanaro
c9c6e04380
Correct description of inheriting from another class (#114660) 
"inherits <someclass>" grates to this reader. I think it should be "inherits from <someclass>".
 2024-02-01 10:07:16 -08:00
Ezio Melotti
bb7923f556
gh-110631: Fix reST indentation in Doc/library (#110685) 
Fix wrong indentation in the Doc/library dir.
 2023-10-11 22:24:12 +02:00
Erlend E. Aasland
8178a88bd8
gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268) 
- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-08-29 19:13:38 +00:00
Erlend E. Aasland
38afa4af9b
gh-107801: Document io.TextIOWrapper.tell (#108265) 2023-08-27 20:35:27 +00:00
Erlend E. Aasland
7f87ebbc3f
gh-107801: Improve the accuracy of io.TextIOWrapper.seek docs (#107933) 
Clearly document the supported seek() operations:

- Rewind to the start of the stream
- Restore a previous stream position (given by tell())
- Fast-forward to the end of the stream
 2023-08-22 09:37:53 +02:00
Erlend E. Aasland
5c76899dad
Docs: Fix Sphinx warnings in io.rst (#107903) 
- Mark up parameter and argument names properly
- If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-08-17 19:19:01 +00:00
Serhiy Storchaka
4b9948617f
gh-106909: Use role :const: for referencing module constants (GH-106910) 2023-07-21 12:40:37 +03:00
Shantanu
783d1bc51b
gh-91485: Avoid unnecessary use of non-Python syntax in io docs (#101177) 2023-01-20 23:06:10 +01:00
Hugo van Kemenade
fa2d43e518
Docs: Fix backtick errors found by sphinx-lint (#97998) 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
 2022-10-06 18:01:30 -07:00
180909
0d68879104
gh-95691: Doc BufferedWriter and BufferedReader (#95703) 2022-10-05 16:57:42 -07:00
Inada Naoki
87679a6e60
gh-90301: Doc: Add references to PEP 686 (#96816) 
Doc: Add references to PEP 686.
 2022-10-04 15:04:44 -07:00
Raymond Hettinger
511dea0a3e
GH-95880: Clarify StringIO append/overwrite behavior. (GH-96104) 2022-08-21 09:42:15 -05:00
Adam Turner
0efe3a1636
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737) 
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"

This reverts commit 5c1f15b4b1

* Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)"

This reverts commit b63a620014.
 2022-06-21 17:04:46 +02:00
Inada Naoki
0729b31a8b
gh-91952: Make TextIOWrapper.reconfigure() supports "locale" encoding (GH-91982) 2022-05-01 10:44:14 +09:00
slateny
3a8e2b6e65
gh-85864: io docs: Add missing position-only parameters (#91950) 2022-04-30 09:22:33 -06:00
slateny
a3f2cf3ced
gh-85864: Mark positional-only args in io docs (#91683) 2022-04-22 17:30:52 -07:00
Inada Naoki
13b17e2a0a
gh-91156: Fix encoding="locale" in UTF-8 mode (GH-70056) 2022-04-14 16:00:35 +09:00
Inada Naoki
4216dce04b
bpo-47000: Make io.text_encoding() respects UTF-8 mode (GH-32003) 
Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
 2022-04-04 11:46:57 +09:00
slateny
cedd2473a9
bpo-25415: Remove confusing sentence from IOBase docstrings (PR-31631) 2022-03-04 12:35:52 -05:00
David Gilbertson
f9a4352056
Fix typo in io.rst (GH-30218) 2021-12-26 13:11:08 +02:00
andrei kulakov
3b5b99da4b
bpo-43126: Expand docs on io.IOBase.readlines() method (#27061) 
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
 2021-07-13 16:07:56 +02:00
Inada Naoki
4827483f47
bpo-43510: Implement PEP 597 opt-in EncodingWarning. (GH-19481) 
See [PEP 597](https://www.python.org/dev/peps/pep-0597/).

* Add `-X warn_default_encoding` and `PYTHONWARNDEFAULTENCODING`.
* Add EncodingWarning
* Add io.text_encoding()
* open(), TextIOWrapper() emits EncodingWarning when encoding is omitted and warn_default_encoding is enabled.
* _pyio.TextIOWrapper() uses UTF-8 as fallback default encoding used when failed to import locale module. (used during building Python)
* bz2, configparser, gzip, lzma, pathlib, tempfile modules use io.text_encoding().
* What's new entry
 2021-03-29 12:28:14 +09:00
Inada Naoki
b045cdaf34
Doc: io: Remove "In-memory streams" section (GH-24927) 2021-03-25 16:23:50 +09:00
Julien Palard
5c1f15b4b1
bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282) 2021-01-25 15:46:06 +01:00
Andre Delfino
dcc997cd28
[doc] Fix erroneous backslashes in signatures and names (GH-23658) 
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).

The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
 2020-12-16 17:37:28 -08:00
Shantanu
831d58d786
bpo-39691: Clarify io.open_code behavior (GH-19824) 2020-05-01 18:52:10 +01:00
Géry Ogam
3b58a70d9c Improve the io module documentation (GH-15099) 
* Update io.rst

* Apply suggestions from code review

Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com>

Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
 2019-09-11 15:55:13 +01:00
Benjamin Peterson
2a3d4d9c53
Document default parameter of .seek() in the signature. (GH-14691) 2019-07-10 19:43:04 -07:00
Steve Dower
44f91c388a
bpo-37390: Add audit event table to documentations (GH-14406) 
Also updates some (unreleased) event names to be consistent with the others.
 2019-06-27 10:47:59 -07:00
Steve Dower
60419a7e96
bpo-37363: Add audit events for a range of modules (GH-14301) 2019-06-24 08:42:54 -07:00
Harmon
35068bd059 Add missing single quote in io.TextIOWrapper.reconfigure documentation (GH-14246) 
Add a missing single quote character in the documentation for `io.TextIOWrapper.reconfigure`.
 2019-06-19 14:01:26 -07:00
Steve Dower
b82e17e626
bpo-36842: Implement PEP 578 (GH-12613) 
Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs.
 2019-05-23 08:45:22 -07:00
Christopher Head
b13552c4d7 Indicate that seek and tell are mandatory on BufferedRandom. (GH-11216) 
For BufferedReader and BufferedWriter, seek and tell operations are
optional (they may or may not exist based on the underlying stream). For
BufferedRandom, they are mandatory: a BufferedRandom should not be
constructed over an unseekable underlying stream. Document this.
 2019-04-12 08:50:40 -07:00
Steve Palmer
7b97ab35b2 closes bpo-35848: Move all documentation regarding the readinto out of IOBase. (GH-11893) 
Move all documentation regarding the readinto method into either io.RawIOBase or io.BufferedIOBase.

Corresponding changes to documentation in the _pyio.py module.
 2019-04-08 21:35:27 -07:00
Emmanuel Arias
522630a746 bpo-36006: Fix versionchanged directive alignment in io module documentation (GH-11881) 
https://bugs.python.org/issue36006
 2019-02-15 11:02:38 -08:00
Serhiy Storchaka
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174) 2018-12-19 08:09:46 +02:00
Srinivas Thatiparthy (శ్రీనివాస్ తాటిపర్తి)
cd449806fa Minor grammar improvement to io documentation. (GH-10329) 
Independently of -> Independent of
 2018-11-11 20:06:18 -08:00
Stéphane Wirtel
e483f02423 bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037) 2018-10-26 12:52:11 +02:00
Andrés Delfino
b6bb77c2b8 bpo-33804: Document that the argument for io.TextIOBase.read() is optional (GH-7510) 2018-07-07 23:17:16 +03:00
Elena Oat
7ffd4c58fa bpo-22069: Update TextIO documentation (GH-6609) 
Clarify that flush is implied when the call to write contains a newline character.
 2018-05-14 10:48:01 -04:00
INADA Naoki
507434fd50
bpo-15216: io: TextIOWrapper.reconfigure() accepts encoding, errors and newline (GH-2343) 2017-12-21 09:59:53 +09:00
Sanyam Khurana
1b74f9b77a bpo-22671: Clarify and test default read method implementations (#4568) 
Original patch written by Martin Panter, enhanced by Sanyam Khurana.
 2017-12-11 14:42:09 +01:00
Antoine Pitrou
3c2817b688 Fix bpo-30526: Add TextIOWrapper.reconfigure() and a TextIOWrapper.write_through attribute (#1922) 
* Fix bpo-30526: Add TextIOWrapper.reconfigure()

* Apply Nick's improved wording

* Update Misc/NEWS
 2017-06-03 12:32:28 +02:00
Martin Panter
4e946792d7 Issue #23214: Fix formatting of -1 2016-10-21 23:00:10 +00:00
Martin Panter
ccb2c0e310 Issue #23214: Implement optional BufferedReader, BytesIO read1() argument 2016-10-20 23:48:14 +00:00
Serhiy Storchaka
4adf01caae Issue #19795: Improved more markups of True/False. 2016-10-19 18:30:05 +03: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