Skip to content

add more descriptive docstrings #33

@fdiblen

Description

@fdiblen

Example:

        """Copy files to the remote server.

        Args:
            remote_folder (str): path on a remote system to copy the files to
            local_folder (str): path to copy the files from
            verbose (bool):Show verbose info when copying.

        Returns:
            None

        Raises:
            TODO: ValueError: If `name` is equal to `nobody`

        Example:
            This function can be called with `Jane Smith` as argument using

            # >>> from kunefe.my_module import kunefe
            # >>> put_files(remote_folder="/home/xenon/", local_folder="./test_folder")

Metadata

Metadata

Assignees

No one assigned

    Labels

    packagePackage related issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions