Commit graph

79 commits

Author SHA1 Message Date
Miss Islington (bot)
920625309c
[3.12] gh-120823: Fix doc for ftplib.FTP.retrbinary() (GH-121697) (GH-121706)
(cherry picked from commit 422855ad21)

Co-authored-by: mirelagrigoras <47386964+mirelagrigoras@users.noreply.github.com>
Co-authored-by: Mirela Andreea GRIGORAS <magrigoras@bitdefender.com>
2024-07-13 16:35:03 +02:00
Miss Islington (bot)
b83b3cb9da
[3.12] docs: module page titles should not start with a link to themselves (GH-117099) (#118791)
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:42:01 +00:00
Miss Islington (bot)
d46a2a0008
[3.12] gh-97590: Update docs and tests for ftplib.FTP.voidcmd() (GH-96825) (GH-115601)
Since 2f3941d743 this function returns the
response string, rather than nothing.
(cherry picked from commit e88ebc1c40)

Co-authored-by: Matthew Hughes <34972397+matthewhughes934@users.noreply.github.com>
2024-02-17 14:54:50 +02:00
Miss Islington (bot)
644aeb5dbb
[3.12] ftplib docs: timeout doesn't have to be a whole number (GH-115443) (#115445)
ftplib docs: `timeout` doesn't have to be a whole number (GH-115443)
(cherry picked from commit 3fd2ad8241)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-14 10:47:59 +00:00
Miss Islington (bot)
66b7ae6f35
[3.12] Docs: mark up the FTP_TLS() docs with param list (GH-114510) (#114532)
Also turn sentence about prot_p() into a note.

(cherry picked from commit 6fadd68da5)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-24 17:28:34 +01:00
Miss Islington (bot)
d492b19856
[3.12] Docs: mark up FTP.connect() and FTP.login() with param lists (GH-114395) (#114485)
Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7c4f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-23 14:04:01 +00:00
Miss Islington (bot)
e18ceb7564
[3.12] Docs: mark up FTP.retrbinary and FTP.storbinary with param lists (GH-114399) (#114483)
(cherry picked from commit 5277d4c7db)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 14:00:27 +00:00
Miss Islington (bot)
1138fb545f
[3.12] Docs: link to sys.stdout in ftplib docs (GH-114396) (#114397)
(cherry picked from commit de17cf444a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-21 17:47:55 +00:00
Miss Islington (bot)
24fa45b59f
[3.12] Docs: mark up FTP() constructor with param list (GH-114359) (#114382)
(cherry picked from commit 96c15b1c8d)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-21 11:33:23 +00:00
Miss Islington (bot)
5dc4857661
[3.12] Docs: mark up the FTP debug levels as a list (GH-114360) (#114375)
(cherry picked from commit fbc28748ea)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-21 11:26:34 +01:00
Miss Islington (bot)
48bff74590
[3.12] Docs: Add missing line continuation to FTP_TLS class docs (GH-114352) (#114353)
Docs: Add missing line continuation to FTP_TLS class docs (GH-114352)

Regression introduced by b1ad5a5d4.
(cherry picked from commit 8f4f773647)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-20 21:21:00 +01:00
Miss Islington (bot)
a4eb0720f1
[3.12] Docs: structure the ftplib reference (GH-114317) (#114347)
Docs: structure the ftplib reference (GH-114317)

Introduce the following headings and subheadings:

- Reference
  * FTP objects
  * FTP_TLS objects
  * Module variables
(cherry picked from commit b1ad5a5d44)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-20 19:16:53 +00:00
Serhiy Storchaka
ffc7678f46
[3.12] gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894) (GH-106954)
(cherry picked from commit d036db728e)
2023-07-21 14:51:00 +03:00
Serhiy Storchaka
84e52171b5
[3.12] gh-106909: Use role :const: for referencing module constants (GH-106910) (GH-106956)
(cherry picked from commit 4b9948617f)
2023-07-21 14:49:39 +03:00
Miss Islington (bot)
bf62e06e59
[3.12] gh-94172: Update keyfile removal documentation (GH-105392) (#105402)
gh-94172: Update keyfile removal documentation (GH-105392)

Remove the "deprecated:: 3.6" markup, since the parameters (like
keyfile and certfile) got removed in Python 3.12.
(cherry picked from commit 2b8e6e5712)

Co-authored-by: Victor Stinner <vstinner@python.org>
2023-06-06 18:14:55 +00:00
Hugo van Kemenade
9eca7235af
gh-94172: Update docs for params removed in 3.12 (#100431)
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-12-28 14:43:19 -05:00
Christian Heimes
e3b6ff19aa
gh-95451: Update docs for wasm32-emscripten and -wasi platforms (GH-95452)
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Michael Droettboom <mdboom@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-02 21:00:41 +02:00
Mariusz Felisiak
11749e2dc2
bpo-44740: Lowercase "internet" and "web" where appropriate. (#27378)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-07-27 00:11:55 +02:00
Senthil Kumaran
b32c8e9795
Simple Enhancement. Add missing return statements in ftplib documentation. (GH-25968) 2021-05-07 07:08:47 -07:00
Sebastian Pedersen
a1a0eb4a39
bpo-39380: Change ftplib encoding from latin-1 to utf-8 (GH-18048)
Add the encoding in ftplib.FTP and ftplib.FTP_TLS to the
constructor as keyword-only and change the default from "latin-1" to "utf-8"
to follow RFC 2640.
2020-04-14 01:07:56 +02:00
Dong-hee Na
a190e2ade1 bpo-39259: ftplib.FTP/FTP_TLS now reject timeout = 0 (GH-17959) 2020-01-13 20:34:34 +01:00
Prateek Nayak
a7414571a1 bpo-38244: [Documentation] Fix unreliable link to sever in ftplib.rst (#16319) 2019-09-26 17:22:31 +08:00
Stéphane Wirtel
5d326abf2c
Doc: Use the with statement in the first example of the ftplib doc. (GH-16271) 2019-09-26 09:01:18 +02:00
Andrew Scheller
51adfc6ed2 Update ftplib.all_errors documentation to match code (#15026)
The documentation doesn't mention the `EOFError` that https://github.com/python/cpython/blob/master/Lib/ftplib.py#L66 includes
2019-09-11 16:18:00 +02: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
Serhiy Storchaka
0a36ac1a09
bpo-33641: Convert RFC references into links. (GH-7103)
85% of them are already links.
2018-05-31 07:39:00 +03:00
Jelle Zijlstra
9e52c907b5 ftplib.FTP.retrbinary callback gets a bytes, not a str (GH-652) 2017-03-13 10:51:27 +08:00
Jelle Zijlstra
7bb6ac76b2 fix the name of argument to ftplib.FTP.set_pasv and fix wording (GH-653) 2017-03-13 10:19:00 +08:00
Christian Heimes
d04863771b Issue #28022: Deprecate ssl-related arguments in favor of SSLContext.
The deprecation include manual creation of SSLSocket and certfile/keyfile
(or similar) in ftplib, httplib, imaplib, smtplib, poplib and urllib.

ssl.wrap_socket() is not marked as deprecated yet.
2016-09-10 23:23:33 +02:00
Zachary Ware
9f8b3a0b92 Issue #27210: Fix doctests for a few modules.
Initial patch by Jelle Zijlstra.
2016-08-10 00:59:59 -05: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
Martin Panter
fe289c0f6f Issue #26553: Capitalization of HTTP, HTTPS, FTP, and URL
Patch by Anish Shah and Aatish Neupane.
2016-05-28 02:20:39 +00:00
Berker Peksag
42f8548c89 Issue #26580: Remove outdated reference to ftpmirror
Patch by SilentGhost.
2016-03-18 14:26:08 +02:00
Gregory P. Smith
f1b3134d28 Issue #11072: change the incorrect "deprecation" of ftplib dir() and nlst()
APIs into a note that mlsd() is a nicer API if the server supports
it.  They aren't deprecated, they are all different server commands.
Not all servers support all commands.
2015-12-13 22:10:28 -08:00
Martin Panter
828123ce4e Issue #25689: Fix language in ftplib and nntplib docs
Original patch by Silent Ghost.
2015-11-21 22:03:08 +00:00
Martin Panter
2e4571a456 Fix a few grammar problems in the documentation and comments 2015-11-14 01:07:43 +00:00
Martin Panter
7462b64911 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
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
Benjamin Peterson
bab69bf655 update docs for #23111 2014-12-30 15:17:03 -06:00
Berker Peksag
b2fdafe3d2 Issue #22576: Fix signatures of FTP.storbinary() and FTP.storlines() methods.
The correct parameter name is "fp", not "file".
2014-10-08 13:15:04 +03:00
Antoine Pitrou
c5e075ff03 Issue #20913: improve the SSL security considerations to first advocate using create_default_context(). 2014-03-22 18:19:11 +01:00
Christian Heimes
e5b5edfa2c Issue #19781: ftplib now supports SSLContext.check_hostname and server name
indication for TLS/SSL connections.
2013-12-02 02:56:02 +01:00
Serhiy Storchaka
bfdcd436f0 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:14 +03:00
Georg Brandl
036e41de52 Closes #19181: replace non-existing host ftp.cwi.nl with ftp.debian.org in ftplib example. 2013-10-06 18:17:56 +02:00
Jesus Cea
aa24468c9b MERGE: Closes #16789: :meth:quit links to constants instead of own module 2012-12-26 16:47:40 +01:00
Jesus Cea
c73f863a8d Closes #16789: :meth:quit links to constants instead of own module 2012-12-26 16:47:03 +01:00
Ezio Melotti
b28e75d9d6 Merge ftplib doc fix with 3.2. 2012-10-05 14:10:39 +03:00
Ezio Melotti
cbd449b416 The file obj passed to ftp.storbinary/storlines must be opened in binary mode. 2012-10-05 14:09:59 +03:00
Florent Xicluna
6d57d212a8 Documentation typo. 2011-10-23 22:23:57 +02:00
Antoine Pitrou
5574c3012d Replace mentions of socket.error. 2011-10-12 17:53:43 +02:00