From 5d6010394d81926c622c8e08752583427bb15654 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Sta=C5=84czak?= Date: Wed, 15 Jul 2020 09:17:58 +0200 Subject: [PATCH] Add note on using commas in alias descriptions On my installation, using commas in docstring descriptions causes a `error: unsupported operand type(s) for %: 'list' and 'dict'` error. Wrapping the description in a string solves that. --- pubs/config/spec.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pubs/config/spec.py b/pubs/config/spec.py index 6921bae..c98df99 100644 --- a/pubs/config/spec.py +++ b/pubs/config/spec.py @@ -99,6 +99,11 @@ active = force_list(default=list('alias')) # command = !pubs list -k | wc -l # description = lists number of pubs in repo +# To use commas in the description, wrap them in a "" string. For example: +# [[[hellocount]]] +# command = !pubs list -k | wc -l; echo "hello!" +# description = "lists number of pubs in repo, greets the user afterward" + [[git]] # The git plugin will commit changes to the repository in a git repository # created at the root of the pubs directory. All detected changes will be