From ddad90ddef0dd9a0ee40a3bb540aad5c3ac7f6f7 Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Fri, 15 Dec 2023 21:34:38 -0600 Subject: [PATCH] Add examples to the online help for all special properties. --- src/pitpkg/cliconstants.nim | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/src/pitpkg/cliconstants.nim b/src/pitpkg/cliconstants.nim index eb6c722..c9bcd64 100644 --- a/src/pitpkg/cliconstants.nim +++ b/src/pitpkg/cliconstants.nim @@ -101,7 +101,9 @@ Issue Properties: created If present, expected to be an ISO 8601-formatted date that represents the - time when the issue was created. + time when the issue was created. E.g.: + + created: 2023-07-13T13:28:41-05:00 completed @@ -110,12 +112,16 @@ Issue Properties: property automatically when you use the "done" command, and can filter on this value. + completed: 2023-04-27T11:52:28-05:00 + context Allows issues to be organized into contexts. The -c option is short-hand for '-p context:' and the 'list contexts' command will show all values of 'context' set in existing issues. + context: family + delegated-to When an issue now belongs to someone else, but needs to be monitored for @@ -123,17 +129,23 @@ Issue Properties: note how it has been delegated. When present PIT will prepend this value to the issue summary with an accent color. + delegated-to: Bob Ross + hide-until When present, expected to be an ISO 8601-formatted date and used to supress the display of the issue until on or after the given date. + hide-until: 2024-01-01T13:45:00-05:00 + pending When an issue is blocked by a third party, this property can be used to capture details about the dependency When present PIT will display this value after the issue summary. + pending: Results of WCAG analysis. + recurrence When an issue is moved to the "done" state, if the issue has a valid @@ -144,7 +156,7 @@ Issue Properties: A valid recurrence value has a time value and optionally has an source issue ID. For example: - every 5 days, 10a544 + recurrence: every 5 days, 10a544 The first word, "every", is expected to be either "every" or "after". @@ -162,15 +174,15 @@ Issue Properties: Examples: - every day - every 2 days - after 2 days - every week - after 12 hours - every 2 weeks, 10a544 + every day + every 2 days + after 2 days + every week + after 12 hours + every 2 weeks, 10a544 tags If present, expected to be a comma-delimited list of text tags. The -g option is a short-hand for '-p tags:'. -""" \ No newline at end of file +"""