jdb/pit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add examples to the online help for all special properties.

Browse Source
This commit is contained in:
Jonathan Bernard 2023-12-15 21:34:38 -06:00
parent 34ce2b61b9
commit ddad90ddef
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/pitpkg/cliconstants.nim
View File

@ -101,7 +101,9 @@ Issue Properties:
created created
If present, expected to be an ISO 8601-formatted date that represents the 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 completed
@ -110,12 +112,16 @@ Issue Properties:
property automatically when you use the "done" command, and can filter on property automatically when you use the "done" command, and can filter on
this value. this value.
completed: 2023-04-27T11:52:28-05:00
context context
Allows issues to be organized into contexts. The -c option is short-hand Allows issues to be organized into contexts. The -c option is short-hand
for '-p context:<context-name>' and the 'list contexts' command will show for '-p context:<context-name>' and the 'list contexts' command will show
all values of 'context' set in existing issues. all values of 'context' set in existing issues.
context: family
delegated-to delegated-to
When an issue now belongs to someone else, but needs to be monitored for 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 note how it has been delegated. When present PIT will prepend this value
to the issue summary with an accent color. to the issue summary with an accent color.
delegated-to: Bob Ross
hide-until hide-until
When present, expected to be an ISO 8601-formatted date and used to 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. supress the display of the issue until on or after the given date.
hide-until: 2024-01-01T13:45:00-05:00
pending pending
When an issue is blocked by a third party, this property can be used to 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 capture details about the dependency When present PIT will display this
value after the issue summary. value after the issue summary.
pending: Results of WCAG analysis.
recurrence recurrence
When an issue is moved to the "done" state, if the issue has a valid 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 A valid recurrence value has a time value and optionally has an source
issue ID. For example: 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". The first word, "every", is expected to be either "every" or "after".
@ -162,15 +174,15 @@ Issue Properties:
Examples: Examples:
every day every day
every 2 days every 2 days
after 2 days after 2 days
every week every week
after 12 hours after 12 hours
every 2 weeks, 10a544 every 2 weeks, 10a544
tags tags
If present, expected to be a comma-delimited list of text tags. The -g If present, expected to be a comma-delimited list of text tags. The -g
option is a short-hand for '-p tags:<tags-value>'. option is a short-hand for '-p tags:<tags-value>'.
""" """