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

Update docstring for ftp_download #15294

Merged
merged 4 commits into from
Dec 18, 2023
Merged

Update docstring for ftp_download #15294

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe4f6f7
update docstring
czoido Dec 18, 2023
f09546b
minor changes
czoido Dec 18, 2023
4f6a6ff
minor changes
czoido Dec 18, 2023
45371fc
fix format
czoido Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions conan/tools/files/files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,14 +128,14 @@ def get(conanfile, url, md5=None, sha1=None, sha256=None, destination=".", filen

def ftp_download(conanfile, host, filename, login='', password='', secure=False):
"""
Ftp download of a file. Retrieves a file from an FTP server. This doesn’t support SSL, but you
might implement it yourself using the standard Python FTP library.
Ftp download of a file. Retrieves a file from an FTP server.

:param conanfile: The current recipe object. Always use ``self``.
:param host: IP or host of the FTP server
:param filename: Path to the file to be downloaded
:param login: Authentication login
:param password: Authentication password
:param host: IP or host of the FTP server.
:param filename: Path to the file to be downloaded.
:param login: Authentication login.
:param password: Authentication password.
:param secure: Set to True to use FTP over TLS/SSL (FTPS). Defaults to False for regular FTP.
"""
# TODO: Check if we want to join this method with download() one, based on ftp:// protocol
# this has been requested by some users, but the signature is a bit divergent
Expand Down