From be7db99e767a66b02e87686874ffcc1c678efaa6 Mon Sep 17 00:00:00 2001 From: Tristan Van Berkom Date: Fri, 30 Jun 2017 16:25:21 +0900 Subject: utils.py: Use proper reStructuredText notes in API docs --- buildstream/utils.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'buildstream') 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) -- cgit v1.2.1