Skip to content
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

Typo in the documentation of the cmd parameter of ftplib.FTP.retrbinary() #120823

Closed
g-pichler opened this issue Jun 21, 2024 · 1 comment
Closed

Typo in the documentation of the cmd parameter of ftplib.FTP.retrbinary() #120823

g-pichler opened this issue Jun 21, 2024 · 1 comment
Labels
docs Documentation in the Doc dir easy

Comments

@g-pichler
Copy link

g-pichler commented Jun 21, 2024 •
edited by bedevere-app bot
Loading

Documentation

The documentation of the cmd parameter of ftplib.FTP.retrbinary() reads

cmd (str) – An appropriate STOR command: "STOR filename".

I suspect, this was copy-and-pasted from ftplib.FTP.storbinary(). I believe it should read

cmd (str) – An appropriate RETR command: "RETR filename".

Linked PRs
@g-pichler g-pichler added the docs Documentation in the Doc dir label Jun 21, 2024
@terryjreedy
Copy link
Member

terryjreedy commented Jun 21, 2024 •
edited
Loading

Agreed. The retrbinary doc entry does not match its docstring, which includes "cmd: A RETR command." RFC959 confirms that this has the same format as the STOR command: "RETR <SP> <pathname> <CRLF>". Would you like to make the PR? (If not, I or someone else will.) The blurb could just say The ftplib.FTP.retrbinary command arg should be a "RETR" command, not a "STOR command"..

@bedevere-app bedevere-app bot mentioned this issue Jun 22, 2024
Closed
mirelagrigoras pushed a commit to mirelagrigoras/cpython that referenced this issue Jul 13, 2024
@magrigoras-bd
pythongh-120823: Fix doc for ftplib.FTP.retrbinary()
7be158a
@bedevere-app bedevere-app bot mentioned this issue Jul 13, 2024
Closed
mirelagrigoras added a commit to mirelagrigoras/cpython that referenced this issue Jul 13, 2024
@mirelagrigoras @magrigoras-bd
pythongh-120823: Fix doc for ftplib.FTP.retrbinary()
3f8a9b2
@bedevere-app bedevere-app bot mentioned this issue Jul 13, 2024
Merged
encukou pushed a commit that referenced this issue Jul 13, 2024
@mirelagrigoras @magrigoras-bd
gh-120823: Fix doc for ftplib.FTP.retrbinary() (GH-121697)
422855a 
Co-authored-by: Mirela Andreea GRIGORAS <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 13, 2024
@mirelagrigoras @magrigoras-bd @miss-islington
pythongh-120823: Fix doc for ftplib.FTP.retrbinary() (pythonGH-121697)
8954fac 
(cherry picked from commit 422855a)

Co-authored-by: mirelagrigoras <[email protected]>
Co-authored-by: Mirela Andreea GRIGORAS <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Jul 13, 2024
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 13, 2024
@mirelagrigoras @magrigoras-bd @miss-islington
pythongh-120823: Fix doc for ftplib.FTP.retrbinary() (pythonGH-121697)
0aad146 
(cherry picked from commit 422855a)

Co-authored-by: mirelagrigoras <[email protected]>
Co-authored-by: Mirela Andreea GRIGORAS <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Jul 13, 2024
Merged
encukou pushed a commit that referenced this issue Jul 13, 2024
@miss-islington @mirelagrigoras @magrigoras-bd
[3.12] gh-120823: Fix doc for ftplib.FTP.retrbinary() (GH-121697) (GH…
9206253 
…-121706)

(cherry picked from commit 422855a)

Co-authored-by: mirelagrigoras <[email protected]>
Co-authored-by: Mirela Andreea GRIGORAS <[email protected]>
encukou pushed a commit that referenced this issue Jul 13, 2024
@miss-islington @magrigoras-bd
[3.13] gh-120823: Fix doc for ftplib.FTP.retrbinary() (GH-121697) (GH…
b9cfb81 
…-121707)

(cherry picked from commit 422855a)

Co-authored-by: Mirela Andreea GRIGORAS <[email protected]>
@encukou encukou closed this as completed Jul 14, 2024
estyxx pushed a commit to estyxx/cpython that referenced this issue Jul 17, 2024
@mirelagrigoras @magrigoras-bd @estyxx
pythongh-120823: Fix doc for ftplib.FTP.retrbinary() (pythonGH-121697)
364e225 
Co-authored-by: Mirela Andreea GRIGORAS <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@encukou @g-pichler @terryjreedy