From ee87c2117f0308509274f69f003c823393e8bbf0 Mon Sep 17 00:00:00 2001 From: Eduardo Schettino Date: Sun, 12 May 2019 17:01:47 +0800 Subject: [PATCH] minor wording changes. --- CHANGES | 2 +- doc/cmd_other.rst | 4 ++-- doc/dictionary.txt | 1 + doc/tutorial_1.rst | 4 ++-- tests/test_task.py | 2 +- 5 files changed, 7 insertions(+), 6 deletions(-) diff --git a/CHANGES b/CHANGES index 76d5a78c..e316eed5 100644 --- a/CHANGES +++ b/CHANGES @@ -21,7 +21,7 @@ Changes - Add configuration `DOIT_CONFIG` `action_string_formatting` to control command action formatter. - Fix `result_dep`, use result **after** its execution - Fix #286: Support `functools.partial` on tasks' dict metadata `task.title` - - Fix #285: `clean` command, remove targets in reverse DFS order + - Fix #285: `clean` command, remove targets in reverse lexical order 0.31.1 (*2018-03-18*) diff --git a/doc/cmd_other.rst b/doc/cmd_other.rst index f06a3442..2d9253c0 100644 --- a/doc/cmd_other.rst +++ b/doc/cmd_other.rst @@ -124,8 +124,8 @@ is empty, otherwise it will display a warning message. .. note:: The targets' removal order will be the reverse of their lexical ordering. - This ensures that the directory structure formed by the targets is correctly - removed irrespective of their order in the ``targets`` array. + This ensures that files in a directory are removed before the directory + irrespective of their order in the ``targets`` array. The *clean* attribute can be a list of actions. An action could be a string with a shell command or a tuple with a python callable. diff --git a/doc/dictionary.txt b/doc/dictionary.txt index f69f926e..de437342 100644 --- a/doc/dictionary.txt +++ b/doc/dictionary.txt @@ -463,3 +463,4 @@ x' xxx xyz zsh +functools diff --git a/doc/tutorial_1.rst b/doc/tutorial_1.rst index 9aa44845..96c36aa7 100644 --- a/doc/tutorial_1.rst +++ b/doc/tutorial_1.rst @@ -602,7 +602,7 @@ Sub-tasks (items of task group) by default are not reported by the ``list`` comm Note the task's name is composed of the task's group name (aka ``basename``) -followed by a colon `:` and the ``name`` specified as a parameter when ``yield``ing. +followed by a colon `:` and the ``name`` specified as a parameter when ``yield``. From the command line, a single task can be executed like this: @@ -646,7 +646,7 @@ printing imports ================ Getting rid of intermediate computation files (like ``requests.models.deps``) was nice... -but sometimes it is usefull to be able to quickly list the direct imports from a module. +but sometimes it is useful to be able to quickly list the direct imports from a module. Let's create another task that just prints its output in the terminal. diff --git a/tests/test_task.py b/tests/test_task.py index b59d1e2e..4d4214d3 100644 --- a/tests/test_task.py +++ b/tests/test_task.py @@ -437,7 +437,7 @@ def test_keep_non_empty_dirs(self, tmpdir): assert expected == os.path.exists(filename) assert os.path.exists(tmpdir['dir']) - def test_clean_in_reverse_lexical_order(self, tmpdir): + def test_clean_any_order(self, tmpdir): # Remove targets in reverse lexical order so that subdirectories' order # in the targets array is irrelevant targets = tmpdir['files'] + [tmpdir['dir'], tmpdir['subdir']]