summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDennis Fink2021-12-30 20:57:20 +0100
committerDennis Fink2021-12-30 20:57:20 +0100
commitf314b3ff099c30a70a4e026ad698e578ab1a9691 (patch)
tree979c2ade6bf9758f70eb20f6d467a184da00f698
parentc355ccf67385d90970d9c7c913746cf856c216b9 (diff)
downloadpatternutils-f314b3ff099c30a70a4e026ad698e578ab1a9691.tar.gz
patternutils-f314b3ff099c30a70a4e026ad698e578ab1a9691.zip
Add docstring to targs
Diffstat (limited to '')
-rw-r--r--patternutils/commands/targs.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/patternutils/commands/targs.py b/patternutils/commands/targs.py
index 317d5e1..947061f 100644
--- a/patternutils/commands/targs.py
+++ b/patternutils/commands/targs.py
@@ -79,6 +79,12 @@ def targs(
editor: bool,
verbose: bool,
) -> None:
+ """Execute commands based on a template string.
+
+ It reads in a JSON list containing objects, or a stream of objects (if the
+ --stream option is used), which are then supplied to the templating engine,
+ to generate the command to run.
+ """
if stream:
data = map(utils.json_loads, read_from) # type: ignore