-
-
Notifications
You must be signed in to change notification settings - Fork 384
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
Minor updates to readme.md and contributing.md #29
base: master
Are you sure you want to change the base?
Conversation
@@ -12,7 +12,7 @@ Typo corrections, error fixes, better explanations, more examples etc. Open an i | |||
|
|||
### Improve issues | |||
|
|||
Sometimes reported issues lack information, are not reproducible, or are even plain invalid. Help us out to make them easier to resolve. Handling issues takes a lot of time that we could rather spend on fixing bugs and adding features. | |||
Sometimes reported issues lack information, are not reproducible, or are even plain invalid. Help us out to make them easier to resolve. Handling issues takes a lot of time that we would rather spend on fixing bugs and adding features. |
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.
👌
@@ -46,7 +46,7 @@ Come over and say hi anytime you feel like on [Gitter](https://gitter.im/klauscf | |||
- Search the issue tracker before opening an issue | |||
- Ensure you're using the latest version of Taskbook | |||
- Use a descriptive title | |||
- Include as much information as possible; | |||
- Include as much information as possible: |
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.
👌
@@ -195,23 +195,23 @@ $ tb -t @coding @docs Update contributing guidelines | |||
|
|||
### Check task | |||
|
|||
To mark a task as complete/incomplete, use the `--check`/`-c` option followed by the ids of the target tasks. Note that the option will update to its opposite the `complete` status of the given tasks, thus checking a complete task will render it as pending and a pending task as complete. Duplicate ids are automatically filtered out. | |||
To mark a task as complete/incomplete, use the `--check`/`-c` option followed by the ids of the target tasks. Note that this option will update the `complete` status of the given tasks to their opposite values. Checking a complete task will render it as pending and a pending task as complete. Duplicate ids are automatically filtered out. |
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.
I think it should be: to its opposite value
, since it is just a single status that is updated for each item.
|
||
``` | ||
$ tb -c 1 3 | ||
``` | ||
|
||
### Star Item | ||
|
||
To mark one or more items as favorite, use the `--star`/`-s` option followed by the ids of the target items. The functionality of this option is the same as the one of the above described `--check` option. | ||
To mark one or more items as favorite, use the `--star`/`-s` option followed by the ids of the target items. The functionality of this option is the same as the `--check` option described above. |
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.
This one could just be completely simplified to:
The functionality of this option is the same as the one of `--check`/`-c`.
|
||
``` | ||
$ tb -s 1 2 3 | ||
``` | ||
|
||
### Display Boards | ||
|
||
Invoking taskbook without any options will display all of saved items grouped into their respective boards. | ||
Invoking taskbook without any options will display all of your saved items grouped into their respective boards. |
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.
👌
@@ -277,7 +277,7 @@ $ tb -r 1 2 | |||
|
|||
### List Items | |||
|
|||
To list a group of items where each item complies with a specif number of attributes, use the `--list`/`-l` option followed by the desired attributes. Board names along with item traits can be considered valid listing attributes. For example to list all items that belong to the default `myboard` and are pending tasks, the following could be used; | |||
To list a group of items that match specific attributes, use the `--list`/`-l` option followed by the desired attributes. Board names along with item traits can be considered valid listing attributes. For example to list all items that belong to the default `myboard` and are pending tasks, the following could be used: |
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.
In order to make it as clear as possible that it can be a group/set of attributes, this could be updated to:
To list a group of items that match a specific set of attributes,
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.
A couple of tweaks and it is good to go. Thank you for taking the time to propose the improvements : )
Minor changes to readme.md
check task
star item
display boards
list items
Minor changes to contributing.md
could
towould