contrapunctus
/
chronometrist
Archived
1
3
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Update documentation for date key-values

This commit is contained in:
contrapunctus 2022-02-15 20:32:07 +05:30
parent 2aef569656
commit bf40c72250
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
elisp/chronometrist.el
View File

@ -889,7 +889,7 @@ Return path of new file if successfully created, and nil if it already exists.")
;; [[file:chronometrist.org::*latest-date-records][latest-date-records:1]]
(cl-defgeneric chronometrist-latest-date-records (backend)
"Return intervals of latest day in BACKEND as a tagged list (\"DATE\" PLIST*).
"Return intervals of latest day in BACKEND as a tagged list (\"DATE\" [<KEYWORD> <VALUE>]* PLIST+).
Return nil if BACKEND contains no records.")
;; latest-date-records:1 ends here

8
elisp/chronometrist.org
View File

@ -1561,7 +1561,7 @@ Return path of new file if successfully created, and nil if it already exists.")
***** latest-date-records :generic:function:
#+BEGIN_SRC emacs-lisp
(cl-defgeneric chronometrist-latest-date-records (backend)
"Return intervals of latest day in BACKEND as a tagged list (\"DATE\" PLIST*).
"Return intervals of latest day in BACKEND as a tagged list (\"DATE\" [<KEYWORD> <VALUE>]* PLIST+).
Return nil if BACKEND contains no records.")
#+END_SRC
@ -2544,11 +2544,11 @@ This is largely like the plist backend, but plists are grouped by date by wrappi
#+BEGIN_SRC emacs-lisp :tangle no :load no
("<ISO-8601 date>"
[:keyword <value>]* ;; key-values for the date itself
(:name "Task Name"
[:keyword <value>]*
[:keyword <value>]* ;; key-values for a plist
:start "<ISO-8601 time>"
:stop "<ISO-8601 time>")
...)
:stop "<ISO-8601 time>")+)
#+END_SRC
This makes it easy and computationally cheap to perform our most common query - getting the plists on a given day. [[#explanation-midnight-spanning-intervals][Midnight-spanning intervals]] are split in the file itself. The downside is that the user, if editing it by hand, must take care to split the intervals.