Skip to content

Commit fff056c

Browse files
committed
Fix documentation
1 parent 5ecd3b8 commit fff056c

File tree

3 files changed

+11
-17
lines changed

3 files changed

+11
-17
lines changed

manual.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ Two user options control how the Agenda mode buffer is displayed and whether the
623623

624624
Before being inserted into an Agenda mode buffer, the items are sorted. Sorting can be customized using the user option `taskpaper-agenda-sorting-predicate`. If the variable is `nil`, which is the default setting, agenda items just appear in the sequence in which they are found in the agenda files. The sorting predicate function is called with two string arguments, the items to compare, and should return non-nil if the first item should sort before the second one.
625625

626-
In the example below items will be sorted according to their due dates form earliest to latest. The sorting is done by date & time value (converted to float number of seconds since the beginning of the epoch). Items, which have no or empty `@due` tag, are assumed to have 2100-12-12 as due date, effectively ending up at the bottom of the sorted list.
626+
In the example below items will be sorted according to their due dates form earliest to latest. The sorting is done by date & time value (converted to float number of seconds since the 1970 epoch). Items, which have no or empty `@due` tag, are assumed to have 2100-12-12 as due date, effectively ending up at the bottom of the sorted list.
627627

628628
```elisp
629629
(setq taskpaper-agenda-sorting-predicate

scripting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ In addition to the existing sorting functions `taskpaper-sort-by-text` and `task
320320
#'my-taskpaper-sort-by-priority)
321321
```
322322

323-
The next function sorts items according to their due dates. The sorting is done by date/time value (converted to float number of seconds since the beginning of the epoch). Items, which have no or empty `@due` tag, are assumed to have 2100-12-12 as due date, effectively ending up at the bottom of the sorted list.
323+
The next function sorts items according to their due dates. The sorting is done by date/time value (converted to float number of seconds since the 1970 epoch). Items, which have no or empty `@due` tag, are assumed to have 2100-12-12 as due date, effectively ending up at the bottom of the sorted list.
324324

325325
```elisp
326326
(defun my-taskpaper-sort-by-due-date ()

taskpaper-mode.el

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2563,9 +2563,9 @@ included."
25632563

25642564
(defun taskpaper-time-string-to-seconds (time-str &optional timedecode)
25652565
"Convert time string TIME-STR to a float number of seconds.
2566-
Return the float number of seconds since the beginning of the
2567-
epoch. When TIMEDECODE time value is given, calculate time based
2568-
on this time, otherwise use current time."
2566+
Return the float number of seconds since the 1970 epoch. When
2567+
TIMEDECODE time value is given, calculate time based on this
2568+
time, otherwise use current time."
25692569
(float-time (apply #'encode-time
25702570
(taskpaper-parse-time-string time-str timedecode))))
25712571

@@ -3084,8 +3084,7 @@ Case is ignored."
30843084
"Return t if two arg time strings are equal.
30853085
Time string are converted to a float number of seconds before
30863086
numeric comparing. If any argument is a float number, it will be
3087-
treated as the float number of seconds since the beginning of the
3088-
epoch."
3087+
treated as the float number of seconds since the 1970 epoch."
30893088
(cond ((and a b)
30903089
(setq a (taskpaper-2ft a) b (taskpaper-2ft b))
30913090
(and (> a 0) (> b 0) (= a b)))
@@ -3095,8 +3094,7 @@ epoch."
30953094
"Return t if first arg time string is less than second.
30963095
Time string are converted to a float number of seconds before
30973096
numeric comparing. If any argument is a float number, it will be
3098-
treated as the float number of seconds since the beginning of the
3099-
epoch."
3097+
treated as the float number of seconds since the 1970 epoch."
31003098
(cond ((and a b)
31013099
(setq a (taskpaper-2ft a) b (taskpaper-2ft b))
31023100
(and (> a 0) (> b 0) (< a b)))
@@ -3106,8 +3104,7 @@ epoch."
31063104
"Return t if first arg time string is less than or equal to second.
31073105
Time string are converted to a float number of seconds before
31083106
numeric comparing. If any argument is a float number, it will be
3109-
treated as the float number of seconds since the beginning of the
3110-
epoch."
3107+
treated as the float number of seconds since the 1970 epoch."
31113108
(cond ((and a b)
31123109
(setq a (taskpaper-2ft a) b (taskpaper-2ft b))
31133110
(and (> a 0) (> b 0) (<= a b)))
@@ -3117,8 +3114,7 @@ epoch."
31173114
"Return t if first arg time string is greater than second.
31183115
Time string are converted to a float number of seconds before
31193116
numeric comparing. If any argument is a float number, it will be
3120-
treated as the float number of seconds since the beginning of the
3121-
epoch."
3117+
treated as the float number of seconds since the 1970 epoch."
31223118
(cond ((and a b)
31233119
(setq a (taskpaper-2ft a) b (taskpaper-2ft b))
31243120
(and (> a 0) (> b 0) (> a b)))
@@ -3128,8 +3124,7 @@ epoch."
31283124
"Return t if first arg time string is greater than or equal to second.
31293125
Time string are converted to a float number of seconds before
31303126
numeric comparing. If any argument is a float number, it will be
3131-
treated as the float number of seconds since the beginning of the
3132-
epoch."
3127+
treated as the float number of seconds since the 1970 epoch."
31333128
(cond ((and a b)
31343129
(setq a (taskpaper-2ft a) b (taskpaper-2ft b))
31353130
(and (> a 0) (> b 0) (>= a b)))
@@ -3139,8 +3134,7 @@ epoch."
31393134
"Return t if two arg time strings are not equal.
31403135
Time string are converted to a float number of seconds before
31413136
numeric comparing. If any argument is a float number, it will be
3142-
treated as the float number of seconds since the beginning of the
3143-
epoch."
3137+
treated as the float number of seconds since the 1970 epoch."
31443138
(cond ((and a b)
31453139
(setq a (taskpaper-2ft a) b (taskpaper-2ft b))
31463140
(and (> a 0) (> b 0) (not (= a b))))

0 commit comments

Comments
 (0)