From f314b3ff099c30a70a4e026ad698e578ab1a9691 Mon Sep 17 00:00:00 2001 From: Dennis Fink Date: Thu, 30 Dec 2021 20:57:20 +0100 Subject: Add docstring to targs --- patternutils/commands/targs.py | 6 ++++++ 1 file changed, 6 insertions(+) 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 -- cgit v1.3.1