Skip to content

Docs: mark up FTP.connect() and FTP.login() with param lists #114395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Jan 23, 2024
Merged

Docs: mark up FTP.connect() and FTP.login() with param lists #114395

merged 8 commits into from
Jan 23, 2024

Conversation

@erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jan 21, 2024 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added awaiting core review docs Documentation in the Doc dir labels Jan 21, 2024
erlend-aasland
erlend-aasland commented Jan 21, 2024
View reviewed changes
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jan 21, 2024

This PR builds on the previous ftplib doc updates, #114359, #114360, and #114317. I tried to reduce text duplication in the constructor by linking to the instance method docs.

@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jan 21, 2024

Digression: the ftplib API feels a little bit weird to use. I'd expected something a la the sqlite3 module: a module level connect function that connected and logged in to an FTP server.

ezio-melotti
ezio-melotti reviewed Jan 21, 2024
View reviewed changes
@CAM-Gerlach CAM-Gerlach mentioned this pull request Jan 22, 2024
Merged
ezio-melotti
ezio-melotti reviewed Jan 22, 2024
View reviewed changes
@erlend-aasland @ezio-melotti
Apply suggestions from code review
0316e91 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jan 22, 2024

Thanks, Ezio!

@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jan 23, 2024

Ezio's remarks have been addressed. I'm going to land this tomorrow.

hugovk
hugovk approved these changes Jan 23, 2024
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, some non-blocking suggestions.

erlend-aasland and others added 2 commits January 23, 2024 14:49
@erlend-aasland @hugovk
Apply suggestions from code review
3477916 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@erlend-aasland
Also change line 104
745978e
@erlend-aasland erlend-aasland enabled auto-merge (squash) January 23, 2024 13:52
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jan 23, 2024

Thanks, both!

@erlend-aasland erlend-aasland merged commit 01105c7 into python:main Jan 23, 2024
@erlend-aasland erlend-aasland deleted the docs/ftplib/wip branch January 23, 2024 13:57
@miss-islington-app

This comment was marked as outdated.

Sign in to view
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 23, 2024
@erlend-aasland @ezio-melotti
@hugovk @miss-islington
Docs: mark up FTP.connect() and FTP.login() with param lists (pythonG…
768b778 
…H-114395)

Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7)

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>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 23, 2024
@erlend-aasland @ezio-melotti
@hugovk @miss-islington
Docs: mark up FTP.connect() and FTP.login() with param lists (pythonG…
4afa635 
…H-114395)

Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7)

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>
@bedevere-app
Copy link

bedevere-app bot commented Jan 23, 2024

GH-114485 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Jan 23, 2024
@bedevere-app
Copy link

bedevere-app bot commented Jan 23, 2024

GH-114486 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Jan 23, 2024
erlend-aasland added a commit that referenced this pull request Jan 23, 2024
@miss-islington @erlend-aasland
@ezio-melotti @hugovk
[3.11] Docs: mark up FTP.connect() and FTP.login() with param lists (G…
8790e57 
…H-114395) (#114486)

Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7)

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>
erlend-aasland added a commit that referenced this pull request Jan 23, 2024
@miss-islington @erlend-aasland
@ezio-melotti @hugovk
[3.12] Docs: mark up FTP.connect() and FTP.login() with param lists (G…
d492b19 
…H-114395) (#114485)

Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7)

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>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@erlend-aasland @ezio-melotti
@hugovk @aisk
Docs: mark up FTP.connect() and FTP.login() with param lists (python#…
2d17a3a 
…114395)

Use rst substitutions to reduce raw text duplication.

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@erlend-aasland @ezio-melotti
@hugovk @Glyphack
Docs: mark up FTP.connect() and FTP.login() with param lists (python#…
da8758b 
…114395)

Use rst substitutions to reduce raw text duplication.

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner

@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@erlend-aasland @hugovk @ezio-melotti