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.

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

Merged
merged 8 commits into from
Jan 23, 2024

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jan 21, 2024

@erlend-aasland
Copy link
Contributor Author

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

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.

@erlend-aasland
Copy link
Contributor Author

Thanks, Ezio!

@erlend-aasland
Copy link
Contributor Author

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

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 erlend-aasland enabled auto-merge (squash) January 23, 2024 13:52
@erlend-aasland
Copy link
Contributor Author

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.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 23, 2024
…H-114395)

Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 23, 2024
…H-114395)

Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@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
…H-114395) (#114486)

Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
erlend-aasland added a commit that referenced this pull request Jan 23, 2024
…H-114395) (#114485)

Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…114395)

Use rst substitutions to reduce raw text duplication.

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
…114395)

Use rst substitutions to reduce raw text duplication.

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants