samschott/maestral
1
1
Fork 0
mirror of https://github.com/samschott/maestral.git synced 2025-01-06 04:08:30 +03:00
Code Issues Projects Releases Wiki Activity

[utils.path] improve docstrings

Browse Source
This commit is contained in:
Sam Schott 2021-03-28 16:40:57 +01:00
parent e1955d0971
commit 601b572441
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/maestral/utils/path.py
View File

@ -274,8 +274,7 @@ def delete(path: str, raise_error: bool = False) -> Optional[OSError]:
Deletes a file or folder at ``path``.
:param path: Path of item to delete.
:param raise_error: If ``True``, raise any OSErrors. If ``False``, catch OSErrors
and return them.
:param raise_error: Whether to raise errors or return them.
:returns: Any caught exception during the deletion.
"""
err = None
@ -309,11 +308,9 @@ def move(
:param dest_path: Destination path. Any existing file at this path will be replaced
by the move. Any existing **empty** folder will be replaced if the source is
also a folder.
:param raise_error: If ``True``, raise any OSErrors. If ``False``, catch OSErrors
and return them.
:param preserve_dest_permissions: If ``True``, attempt to preserve the permissions
of any file at the destination. If ``False``, the permissions of src_path will
be used.
:param raise_error: Whether to raise errors or return them.
:param preserve_dest_permissions: Whether to apply the permissions of the source
path to the destination path. Permissions will not be set recursively.
:returns: Any caught exception during the move.
"""