Skip to content

Commit d8642ff

Browse files
committed
bump version and improve docs
1 parent ff8e566 commit d8642ff

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This project was inspired by the venerable Emacs org-mode and its built-in clock
88

99
Requires Nim with Nimble, version 1.6.6 or compatible.
1010

11-
Version 0.2.1
11+
Version 0.2.2
1212

1313
## Contents
1414

@@ -112,10 +112,21 @@ The only limit to the nested hierarchy is your sanity :) You could do something
112112

113113
## Caveats
114114

115-
There are two things to keep in mind while using this extension:
115+
There are two things to keep in mind while using this extension.
116116

117-
1. The tag order of your timewarrior intervals is important. They should all have the same tags in the same order. This extension always expects the first tag to be the description or the project tag. If there is a project tag, the task description falls back to the second tag. All other tags after the project/description may be used as client rate exceptions. _Timewarrior does not help you preserve tag order_. If you are not careful with the `tag` or `untag` command, reports might get confused.
118-
2. Accuracy for billable hours is calculated by the minute and truncated at the hundredth (2nd) decimal place. This sacrifice is made to help the table add up from bottom to top, or when multiplying hours against the rate at any given point in the table. Without this, rounding errors will occur and the table will seem inconsistent.
117+
1. Timewarrior tag order.
118+
119+
The tag order of your timewarrior intervals is important. They should all have the same tags in the same order.
120+
121+
This extension always expects the first tag to be the description or the project tag. If there is a project tag, the task description falls back to the second tag.
122+
123+
All other tags after the project/description may be used as client rate exceptions. _Timewarrior does not help you preserve tag order_. If you are not careful with the `tag` or `untag` command, reports might miss data or get confusing.
124+
125+
2. Billable hour accuracy is truncated.
126+
127+
Billable hours are calculated by the second and truncated at the hundredth (2nd) decimal place. This sacrifice is made to help the table add up from bottom to top, or when multiplying hours against the rate at any given point in the table.
128+
129+
Without this, rounding errors will occur and the table will seem inconsistent. Generally speaking the table is accurate enough.
119130

120131
I am open to ideas and contributions.
121132

billable.nimble

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Package
22

3-
version = "0.2.1"
3+
version = "0.2.2"
44
author = "Trevor Richards <[email protected]>"
55
description = "timew-billable"
66
license = "GPL3"

0 commit comments

Comments
 (0)