Skip to content

Commit a8c39b8

Browse files
committed
Typos and updates in base-tasks
1 parent cc495b3 commit a8c39b8

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ScriptEngine
1+
venv# ScriptEngine
22

33
![Tests](https://github.com/uwefladrich/scriptengine/actions/workflows/pytest.yml/badge.svg)
44
![Test coverage](https://coveralls.io/repos/github/uwefladrich/scriptengine/badge.svg)

docs/sphinx/base-tasks.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ the given directory::
186186
args: [-l]
187187
cwd: /tmp
188188

189-
When the ``stdout`` is given, it can be eiter true, false, or a string that
189+
When the ``stdout`` is given, it can be either true, false, or a string that
190190
makes for a valid name in the ScriptEngine context. If ``stdout`` is set to true
191191
(the default), then the standard output of the command is printed as log
192192
messages on the INFO level. When ``stdout`` is false, the standard output of the
@@ -216,7 +216,7 @@ used::
216216
(see `base.context`_). This implies, among other things, that list items are
217217
*appended* if the list is already defined in the context. This mechanism
218218
applies also to ``base.command`` and consequently output lines are appended
219-
to the context variable if it already exist.
219+
to the context variable if it already exists.
220220

221221
The ``stderr`` argument works exactly as ``stdout``, but for standard error
222222
output.
@@ -330,7 +330,8 @@ Creates a new directory at the given ``path``::
330330
path: <PATH>
331331

332332
If ``path`` already exists, an info message is displayed (no warning or error).
333-
When ``path`` is a file or symbolic link, an error occurs.
333+
This task creates parent directories as needed. An error is raised when
334+
``path`` is a file or symbolic link.
334335

335336
A list of names is accepted for the ``path`` argument.
336337

@@ -346,11 +347,11 @@ This task copies the file or directory given by ``src`` to ``dst``::
346347

347348
If ``src`` is a file and ``dst`` is a directory, the ``src`` file is copied into
348349
the ``dst/`` directory. If ``src`` is a directory, ``dst`` must be a directory
349-
as well and ``src`` is copied recursively into ``dst/``. When a directory is
350+
as well and ``src`` is copied recursively into ``dst``. When a directory is
350351
copied, symbolic links are preserved.
351352

352353
When copying a file and the ``dst`` exists already, it is overwritten and a
353-
waring is issued. Copying a directory when ``dst`` already exists results in
354+
warning is issued. Copying a directory when ``dst`` already exists results in
354355
an error. An error occurs if ``src`` does not exist, unless ``ignore_not_found``
355356
is ``true``.
356357

0 commit comments

Comments
 (0)