Skip to content

Commit

Permalink
Fix docstrings for RTD build... second try.
Browse files Browse the repository at this point in the history
  • Loading branch information
GeigerJ2 committed Dec 12, 2024
1 parent 4ef2fca commit d91f4f1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/aiida/orm/nodes/data/remote/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -201,16 +201,16 @@ def get_size_on_disk(
method: str = 'du',
return_bytes: bool = False,
) -> int | str:
"""Connects to the remote Computer of the `RemoteData` ojbect and returns the total size of a file or a
"""Connects to the remote Computer of the `RemoteData` object and returns the total size of a file or a
directory at the given `relpath` in a human-readable format.
:param relpath: File or directory path for which the total size should be returned, relative to
``self.get_remote_path()``.
``self.get_remote_path()``.
:param method: Method to be used to evaluate the directory/file size (either ``du`` or ``lstat``).
:param return_bytes: Return the total byte size is int, or in human-readable format.
:raises: ``FileNotFoundError``, if file or directory does not exist anymore on the remote ``Computer``.
:raises: ``NotImplementedError``, if a method other than ``du`` or ``lstat`` is selected.
:raises FileNotFoundError: If file or directory does not exist anymore on the remote ``Computer``.
:raises NotImplementedError: If a method other than ``du`` or ``lstat`` is selected.
:return: Total size of given file or directory.
"""
Expand Down

0 comments on commit d91f4f1

Please sign in to comment.