diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-06-30 16:25:21 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-06-30 16:25:21 +0900 |
| commit | be7db99e767a66b02e87686874ffcc1c678efaa6 (patch) | |
| tree | 505becb70b247da61687bbb92282f54406dd06c0 /buildstream/utils.py | |
| parent | f2d890e7494e06fd835b6f63a5c1e3a2dc1018bd (diff) | |
| download | buildstream-be7db99e767a66b02e87686874ffcc1c678efaa6.tar.gz | |
utils.py: Use proper reStructuredText notes in API docs
Diffstat (limited to 'buildstream/utils.py')
| -rw-r--r-- | buildstream/utils.py | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/buildstream/utils.py b/buildstream/utils.py index 5bf3863d2..d84f0163f 100644 --- a/buildstream/utils.py +++ b/buildstream/utils.py @@ -290,11 +290,11 @@ def copy_files(src, dest, files=None, ignore_missing=False): Returns: (:class:`~.FileListResult`): The result describing what happened during this file operation - Note:: + .. note:: - Directories in `dest` are replaced with files from `src`, - unless the existing directory in `dest` is not empty in which - case the path will be reported in the return value. + Directories in `dest` are replaced with files from `src`, + unless the existing directory in `dest` is not empty in which + case the path will be reported in the return value. """ if files is None: files = list_relative_paths(src) @@ -316,11 +316,11 @@ def move_files(src, dest, files=None, ignore_missing=False): Returns: (:class:`~.FileListResult`): The result describing what happened during this file operation - Note:: + .. note:: - Directories in `dest` are replaced with files from `src`, - unless the existing directory in `dest` is not empty in which - case the path will be reported in the return value. + Directories in `dest` are replaced with files from `src`, + unless the existing directory in `dest` is not empty in which + case the path will be reported in the return value. """ if files is None: files = list_relative_paths(src) @@ -342,16 +342,16 @@ def link_files(src, dest, files=None, ignore_missing=False): Returns: (:class:`~.FileListResult`): The result describing what happened during this file operation - Note:: + .. note:: - Directories in `dest` are replaced with files from `src`, - unless the existing directory in `dest` is not empty in which - case the path will be reported in the return value. + Directories in `dest` are replaced with files from `src`, + unless the existing directory in `dest` is not empty in which + case the path will be reported in the return value. - Note:: + .. note:: - If a hardlink cannot be created due to crossing filesystems, - then the file will be copied instead. + If a hardlink cannot be created due to crossing filesystems, + then the file will be copied instead. """ if files is None: files = list_relative_paths(src) |