Skip to content
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

"note" command should be "annotate" #180

Open
axelsimon opened this issue Aug 9, 2023 · 1 comment
Open

"note" command should be "annotate" #180

axelsimon opened this issue Aug 9, 2023 · 1 comment

Comments

@axelsimon
Copy link
Contributor

Hi,
All of what I'm about to say is probably personal, but I thought I'd share.
I think there's a small inconsistency in how the dstask note command is named.

If you look at dstask commands, they fall more or less in one of three basic categories:

  • filter (next, show-tags, show-*.)
  • action (add, log, start, stop, done, modify, edit, undo, sync, open and… note)
  • other (git, template, bash-completion, help, version)

"note" is an action, but its command is not a verb, unlike essentially all the other.
There is an exception with "done", but I'd argue that "done" is specific enough that it's not surprising and still makes sense, although it could helpfully have dstask resolve as a synonym, for consistency.

When looking to add a note, I want to tell dstask to "annotate", and not to "note".
If "note" must exist, i'd expect "note" to display the notes about a task, more like a "filter" subcommand.

Am I over-thinking this?

@naggie
Copy link
Owner

naggie commented Aug 17, 2023

No I think you're right! I think note should become annotate, leaving an alias note.

I think resolve is more consistent too, and matches the database

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants