-
Notifications
You must be signed in to change notification settings - Fork 105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify wording on dates #21
base: master
Are you sure you want to change the base?
Conversation
Wouldn't the completion date be always optional also? I mean, the format doesn't require a completion date ever. The wording should be something like: If you've used the prepended date (optional), you can use that with the completed date (also optional) to calculate how many days it took to complete a task. Do I understand it correctly? |
I think this is slightly better: If you've used the prepended date (optional), you can use that with the completed date (which is in that case required) to calculate how many days it took to complete a task. For finished tasks a completion date is required if a creation date is present. See:
This part not only gives information on where the location of the completion date, but it also points to the completion date being required if a creation date is present. Otherwise, sorting tasks by date completion date wouldn't work. This together with
leads me to believe that a completion date is required only when a creation date is present. I do not think a completion date is required in all cases, which is the way @daniellandau explains it in JMoerman/Go-For-It#56, as:
In any case, I agree that
should be replaced with a less confusing sentence. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please rewrite to resemble the sentence as discussed: If you've used the prepended date (optional), you can use that with the completed date (which is in that case required) to calculate how many days it took to complete a task.
As that would be the most clear paragraph. Do you agree?
I agree the existing language is poorly worded and ambiguous. In addition, if we assume for a moment that completion date is mandatory, then that makes the todo.txt specification incompatible with existing todo.txt files (including the sample http://todotxt.org/todo.txt). Version 1.4 of todo.sh did NOT add completion dates. Sadly some history has been lost due to bitrot and hosting services disappearing since 2006. too-much-todotxt/spec#15 includes references and previous discussions on this topic. |
My attempt to resolve https://github.com/too-much-todotxt/spec/blob/main/The-Todo.txt-Format.md based on 2006 specification and 2009 changes to todo.sh (which leaked into spec). |
The previous wording could be understood to mean that completion date is mandatory if and only if creation date is also included.