Update function reference; remove unused functions
Removed chronometrist-report-format-date chronometrist-statistics-format-date chronometrist-interval
This commit is contained in:
parent
b2c7d2763c
commit
b5c5cfd4a2
|
@ -94,14 +94,6 @@ The first date is the first occurrence of
|
||||||
(vector))))))
|
(vector))))))
|
||||||
chronometrist-task-list)))
|
chronometrist-task-list)))
|
||||||
|
|
||||||
(defun chronometrist-report-format-date (format-string time-date)
|
|
||||||
"Extract date from TIME-DATE and format it according to FORMAT-STRING."
|
|
||||||
(->> time-date
|
|
||||||
(-take 6)
|
|
||||||
(-drop 3)
|
|
||||||
(reverse)
|
|
||||||
(apply #'format format-string)))
|
|
||||||
|
|
||||||
(defun chronometrist-report-print-keybind (command &optional description firstonly)
|
(defun chronometrist-report-print-keybind (command &optional description firstonly)
|
||||||
"Insert one or more keybindings for COMMAND into the current buffer.
|
"Insert one or more keybindings for COMMAND into the current buffer.
|
||||||
DESCRIPTION is a description of the command.
|
DESCRIPTION is a description of the command.
|
||||||
|
|
|
@ -166,11 +166,6 @@ If FIRSTONLY is non-nil, return only the first keybinding found."
|
||||||
" - "
|
" - "
|
||||||
(if description description "")))
|
(if description description "")))
|
||||||
|
|
||||||
(defun chronometrist-statistics-format-date (date)
|
|
||||||
"Return DATE (YEAR MONTH DAY) as a string in the form \"YYYY-MM-DD\"."
|
|
||||||
(-let [(year month day) date]
|
|
||||||
(format "%04d-%02d-%02d" year month day)))
|
|
||||||
|
|
||||||
(defun chronometrist-statistics-print-non-tabular ()
|
(defun chronometrist-statistics-print-non-tabular ()
|
||||||
"Print the non-tabular part of the buffer in `chronometrist-statistics'."
|
"Print the non-tabular part of the buffer in `chronometrist-statistics'."
|
||||||
(let ((w "\n ")
|
(let ((w "\n ")
|
||||||
|
|
|
@ -98,14 +98,6 @@ SECONDS must be a positive integer."
|
||||||
(h (/ seconds 3600)))
|
(h (/ seconds 3600)))
|
||||||
(list h m s)))
|
(list h m s)))
|
||||||
|
|
||||||
(defun chronometrist-interval (event)
|
|
||||||
"Return the period of time covered by EVENT as a time value.
|
|
||||||
EVENT should be a plist (see `chronometrist-file')."
|
|
||||||
(let ((start (plist-get event :start))
|
|
||||||
(stop (plist-get event :stop)))
|
|
||||||
(time-subtract (parse-iso8601-time-string stop)
|
|
||||||
(parse-iso8601-time-string start))))
|
|
||||||
|
|
||||||
(provide 'chronometrist-time)
|
(provide 'chronometrist-time)
|
||||||
|
|
||||||
;; Local Variables:
|
;; Local Variables:
|
||||||
|
|
148
doc/manual.org
148
doc/manual.org
|
@ -74,7 +74,7 @@
|
||||||
4. Variable - chronometrist-task-list
|
4. Variable - chronometrist-task-list
|
||||||
5. Internal Variable - chronometrist--fs-watch
|
5. Internal Variable - chronometrist--fs-watch
|
||||||
6. Function - chronometrist-current-task ()
|
6. Function - chronometrist-current-task ()
|
||||||
7. Function - chronometrist-format-time (seconds &optional blank)
|
7. Function - chronometrist-format-time (seconds &optional (blank " "))
|
||||||
* seconds -> "h:m:s"
|
* seconds -> "h:m:s"
|
||||||
8. Function - chronometrist-common-file-empty-p (file)
|
8. Function - chronometrist-common-file-empty-p (file)
|
||||||
9. Function - chronometrist-common-clear-buffer (buffer)
|
9. Function - chronometrist-common-clear-buffer (buffer)
|
||||||
|
@ -108,47 +108,47 @@
|
||||||
5. Function - chronometrist-common-create-file ()
|
5. Function - chronometrist-common-create-file ()
|
||||||
6. Function - chronometrist-task-active? (task)
|
6. Function - chronometrist-task-active? (task)
|
||||||
* String -> Boolean
|
* String -> Boolean
|
||||||
7. Function - chronometrist-activity-indicator ()
|
7. Function - chronometrist-use-goals? ()
|
||||||
8. Function - chronometrist-entries ()
|
8. Function - chronometrist-activity-indicator ()
|
||||||
9. Function - chronometrist-task-at-point ()
|
9. Function - chronometrist-entries ()
|
||||||
10. Function - chronometrist-goto-last-task ()
|
10. Function - chronometrist-task-at-point ()
|
||||||
11. Function - chronometrist-print-keybind (command &optional description firstonly)
|
11. Function - chronometrist-goto-last-task ()
|
||||||
12. Function - chronometrist-print-non-tabular ()
|
12. Function - chronometrist-print-keybind (command &optional description firstonly)
|
||||||
13. Function - chronometrist-goto-nth-task (n)
|
13. Function - chronometrist-print-non-tabular ()
|
||||||
14. Function - chronometrist-refresh (&optional ignore-auto noconfirm)
|
14. Function - chronometrist-goto-nth-task (n)
|
||||||
15. Function - chronometrist-refresh-file (fs-event)
|
15. Function - chronometrist-refresh (&optional ignore-auto noconfirm)
|
||||||
16. Command - chronometrist-query-stop ()
|
16. Function - chronometrist-refresh-file (fs-event)
|
||||||
17. Command - chronometrist-in (task &optional prefix)
|
17. Command - chronometrist-query-stop ()
|
||||||
18. Command - chronometrist-out (&optional prefix)
|
18. Command - chronometrist-in (task &optional _prefix)
|
||||||
19. Variable - chronometrist-before-in-functions
|
19. Command - chronometrist-out (&optional _prefix)
|
||||||
20. Variable - chronometrist-after-in-functions
|
20. Variable - chronometrist-before-in-functions
|
||||||
21. Variable - chronometrist-before-out-functions
|
21. Variable - chronometrist-after-in-functions
|
||||||
22. Variable - chronometrist-after-out-functions
|
22. Variable - chronometrist-before-out-functions
|
||||||
23. Function - chronometrist-run-functions-and-clock-in (task)
|
23. Variable - chronometrist-after-out-functions
|
||||||
24. Function - chronometrist-run-functions-and-clock-out (task)
|
24. Function - chronometrist-run-functions-and-clock-in (task)
|
||||||
25. Keymap - chronometrist-mode-map
|
25. Function - chronometrist-run-functions-and-clock-out (task)
|
||||||
26. Major Mode - chronometrist-mode
|
26. Keymap - chronometrist-mode-map
|
||||||
27. Function - chronometrist-toggle-task-button (button)
|
27. Major Mode - chronometrist-mode
|
||||||
28. Function - chronometrist-add-new-task-button (button)
|
28. Function - chronometrist-toggle-task-button (button)
|
||||||
29. Command - chronometrist-toggle-task (&optional prefix inhibit-hooks)
|
29. Function - chronometrist-add-new-task-button (button)
|
||||||
30. Command - chronometrist-toggle-task-no-hooks (&optional prefix)
|
30. Command - chronometrist-toggle-task (&optional prefix inhibit-hooks)
|
||||||
31. Command - chronometrist-add-new-task ()
|
31. Command - chronometrist-toggle-task-no-hooks (&optional prefix)
|
||||||
32. Command - chronometrist (&optional arg)
|
32. Command - chronometrist-add-new-task ()
|
||||||
|
33. Command - chronometrist (&optional arg)
|
||||||
*** chronometrist-events.el
|
*** chronometrist-events.el
|
||||||
1. Variable - chronometrist-events
|
1. Variable - chronometrist-events
|
||||||
* keys - iso-date
|
* keys - iso-date
|
||||||
2. Function - chronometrist-list-midnight-spanning-events ()
|
2. Function - chronometrist-day-start (timestamp)
|
||||||
3. Function - chronometrist-day-start (timestamp)
|
|
||||||
* iso-timestamp -> encode-time
|
* iso-timestamp -> encode-time
|
||||||
4. Function - chronometrist-file-clean ()
|
3. Function - chronometrist-file-clean ()
|
||||||
* commented out, unused
|
* commented out, unused
|
||||||
5. Function - chronometrist-events-maybe-split (event)
|
4. Function - chronometrist-events-maybe-split (event)
|
||||||
6. Function - chronometrist-events-populate ()
|
5. Function - chronometrist-events-populate ()
|
||||||
7. Function - chronometrist-tasks-from-table ()
|
6. Function - chronometrist-tasks-from-table ()
|
||||||
8. Function - chronometrist-events-subset (start end)
|
7. Function - chronometrist-events-subset (start end)
|
||||||
* ts ts -> hash-table
|
* ts ts -> hash-table
|
||||||
9. Function - chronometrist-events-query-spec-match-p (plist specifiers)
|
8. Function - chronometrist-events-query-spec-match-p (plist specifiers)
|
||||||
10. Function - chronometrist-events-query (table &key get specifiers except)
|
9. Function - chronometrist-events-query (table &key get specifiers except)
|
||||||
*** chronometrist-migrate.el
|
*** chronometrist-migrate.el
|
||||||
1. Variable - chronometrist-migrate-table
|
1. Variable - chronometrist-migrate-table
|
||||||
2. Function - chronometrist-migrate-populate (in-file)
|
2. Function - chronometrist-migrate-populate (in-file)
|
||||||
|
@ -165,12 +165,12 @@
|
||||||
*** chronometrist-queries.el
|
*** chronometrist-queries.el
|
||||||
1. Function - chronometrist-last ()
|
1. Function - chronometrist-last ()
|
||||||
* -> plist
|
* -> plist
|
||||||
2. Function - chronometrist-task-time-one-day (task &optional (date-string (chronometrist-queries-date)))
|
2. Function - chronometrist-task-time-one-day (task &optional (ts (ts-now)))
|
||||||
* String &optional iso-date -> seconds
|
* String &optional ts -> seconds
|
||||||
3. Function - chronometrist-active-time-one-day (&optional ts)
|
3. Function - chronometrist-active-time-one-day (&optional ts)
|
||||||
* &optional ts -> seconds
|
* &optional ts -> seconds
|
||||||
4. Function - chronometrist-statistics-count-active-days (task &optional (table chronometrist-events))
|
4. Function - chronometrist-statistics-count-active-days (task &optional (table chronometrist-events))
|
||||||
5. Function - chronometrist-task-events-in-day (task date-string)
|
5. Function - chronometrist-task-events-in-day (task ts)
|
||||||
*** chronometrist-report-custom.el
|
*** chronometrist-report-custom.el
|
||||||
1. Custom variable - chronometrist-report-buffer-name
|
1. Custom variable - chronometrist-report-buffer-name
|
||||||
2. Custom variable - chronometrist-report-week-start-day
|
2. Custom variable - chronometrist-report-week-start-day
|
||||||
|
@ -184,16 +184,15 @@
|
||||||
* ts-1 -> (ts-1 ... ts-7)
|
* ts-1 -> (ts-1 ... ts-7)
|
||||||
6. Function - chronometrist-report-date->week-dates ()
|
6. Function - chronometrist-report-date->week-dates ()
|
||||||
7. Function - chronometrist-report-entries ()
|
7. Function - chronometrist-report-entries ()
|
||||||
8. Function - chronometrist-report-format-date (format-string time-date)
|
8. Function - chronometrist-report-print-keybind (command &optional description firstonly)
|
||||||
9. Function - chronometrist-report-print-keybind (command &optional description firstonly)
|
9. Function - chronometrist-report-print-non-tabular ()
|
||||||
10. Function - chronometrist-report-print-non-tabular ()
|
10. Function - chronometrist-report-refresh (&optional _ignore-auto _noconfirm)
|
||||||
11. Function - chronometrist-report-refresh (&optional ignore-auto noconfirm)
|
11. Function - chronometrist-report-refresh-file (_fs-event)
|
||||||
12. Function - chronometrist-report-refresh-file (fs-event)
|
12. Keymap - chronometrist-report-mode-map
|
||||||
13. Keymap - chronometrist-report-mode-map
|
13. Major Mode - chronometrist-report-mode
|
||||||
14. Major Mode - chronometrist-report-mode
|
14. Function - chronometrist-report (&optional keep-date)
|
||||||
15. Function - chronometrist-report (&optional keep-date)
|
15. Function - chronometrist-report-previous-week (arg)
|
||||||
16. Function - chronometrist-report-previous-week (arg)
|
16. Function - chronometrist-report-next-week (arg)
|
||||||
17. Function - chronometrist-report-next-week (arg)
|
|
||||||
*** chronometrist-key-values.el
|
*** chronometrist-key-values.el
|
||||||
1. Internal Variable - chronometrist--tag-suggestions
|
1. Internal Variable - chronometrist--tag-suggestions
|
||||||
2. Internal Variable - chronometrist--value-suggestions
|
2. Internal Variable - chronometrist--value-suggestions
|
||||||
|
@ -228,19 +227,18 @@
|
||||||
*** chronometrist-statistics.el
|
*** chronometrist-statistics.el
|
||||||
1. Internal Variable - chronometrist-statistics--ui-state
|
1. Internal Variable - chronometrist-statistics--ui-state
|
||||||
2. Internal Variable - chronometrist-statistics--point
|
2. Internal Variable - chronometrist-statistics--point
|
||||||
3. Keymap - chronometrist-statistics-mode-map
|
3. Function - chronometrist-statistics-count-average-time-spent (task &optional (table chronometrist-events))
|
||||||
4. Function - chronometrist-statistics-count-average-time-spent (task &optional (table chronometrist-events))
|
|
||||||
* string &optional hash-table -> seconds
|
* string &optional hash-table -> seconds
|
||||||
5. Function - chronometrist-statistics-entries-internal (table)
|
4. Function - chronometrist-statistics-entries-internal (table)
|
||||||
6. Function - chronometrist-statistics-entries ()
|
5. Function - chronometrist-statistics-entries ()
|
||||||
7. Function - chronometrist-statistics-print-keybind (command &optional description firstonly)
|
6. Function - chronometrist-statistics-print-keybind (command &optional description firstonly)
|
||||||
8. Function - chronometrist-statistics-format-date (date)
|
7. Function - chronometrist-statistics-print-non-tabular ()
|
||||||
9. Function - chronometrist-statistics-print-non-tabular ()
|
8. Function - chronometrist-statistics-refresh (&optional ignore-auto noconfirm)
|
||||||
10. Function - chronometrist-statistics-refresh (&optional ignore-auto noconfirm)
|
9. Keymap - chronometrist-statistics-mode-map
|
||||||
11. Major Mode - chronometrist-statistics-mode
|
10. Major Mode - chronometrist-statistics-mode
|
||||||
12. Command - chronometrist-statistics (&optional preserve-state)
|
11. Command - chronometrist-statistics (&optional preserve-state)
|
||||||
13. Command - chronometrist-statistics-previous-range (arg)
|
12. Command - chronometrist-statistics-previous-range (arg)
|
||||||
14. Command - chronometrist-statistics-next-range (arg)
|
13. Command - chronometrist-statistics-next-range (arg)
|
||||||
*** chronometrist-time.el
|
*** chronometrist-time.el
|
||||||
1. Function - chronometrist-iso-timestamp->ts (timestamp)
|
1. Function - chronometrist-iso-timestamp->ts (timestamp)
|
||||||
* iso-timestamp -> ts
|
* iso-timestamp -> ts
|
||||||
|
@ -260,17 +258,23 @@
|
||||||
5. Command - chronometrist-force-restart-timer ()
|
5. Command - chronometrist-force-restart-timer ()
|
||||||
6. Command - chronometrist-change-update-interval (arg)
|
6. Command - chronometrist-change-update-interval (arg)
|
||||||
*** chronometrist-goals
|
*** chronometrist-goals
|
||||||
1. Custom Variable - chronometrist-goals-list nil
|
1. Internal Variable - chronometrist--timers-list
|
||||||
2. Function - chronometrist-run-at-time (time repeat function &rest args)
|
2. Custom Variable - chronometrist-goals-list nil
|
||||||
3. Function - chronometrist-seconds->alert-string (seconds)
|
3. Function - chronometrist-run-at-time (time repeat function &rest args)
|
||||||
4. Function - chronometrist-approach-alert (task goal spent)
|
4. Function - chronometrist-seconds->alert-string (seconds)
|
||||||
5. Function - chronometrist-complete-alert (task goal spent)
|
* seconds -> string
|
||||||
6. Function - chronometrist-exceed-alert (task goal spent)
|
5. Function - chronometrist-approach-alert (task goal spent)
|
||||||
7. Function - chronometrist-no-goal-alert (task goal spent)
|
* string minutes minutes
|
||||||
8. Custom Variable - chronometrist-goals-alert-functions
|
6. Function - chronometrist-complete-alert (task goal spent)
|
||||||
9. Function - chronometrist-get-goal (task &optional (goals-list chronometrist-goals-list))
|
* string minutes minutes
|
||||||
* String &optional List -> minutes
|
7. Function - chronometrist-exceed-alert (task goal spent)
|
||||||
10. Internal Variable - chronometrist--timers-list
|
* string minutes minutes
|
||||||
|
8. Function - chronometrist-no-goal-alert (task goal spent)
|
||||||
|
* string minutes minutes
|
||||||
|
9. Custom Variable - chronometrist-goals-alert-functions
|
||||||
|
* each function is passed - string minutes minutes
|
||||||
|
10. Function - chronometrist-get-goal (task &optional (goals-list chronometrist-goals-list))
|
||||||
|
* String &optional List -> minutes
|
||||||
11. Function - chronometrist-goals-run-alert-timers (task)
|
11. Function - chronometrist-goals-run-alert-timers (task)
|
||||||
12. Function - chronometrist-goals-stop-alert-timers (&optional _task)
|
12. Function - chronometrist-goals-stop-alert-timers (&optional _task)
|
||||||
13. Function - chronometrist-goals-on-file-change ()
|
13. Function - chronometrist-goals-on-file-change ()
|
||||||
|
|
Reference in New Issue