From cc9727f7f2d834317a8a14371bf93928bd986f17 Mon Sep 17 00:00:00 2001 From: Patrick De Young Date: Thu, 2 Aug 2018 10:15:56 +1000 Subject: [PATCH 1/2] change could to would in contributing.md --- contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contributing.md b/contributing.md index df742698..7adddea5 100644 --- a/contributing.md +++ b/contributing.md @@ -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. ### Give feedback on issues @@ -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: - Steps to reproduce the issue - Error message - Taskbook version From 9b4bf3ca5c168295c0651a81dd569cdc25165111 Mon Sep 17 00:00:00 2001 From: Patrick De Young Date: Thu, 2 Aug 2018 10:20:32 +1000 Subject: [PATCH 2/2] minor updates to readme.md --- readme.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index ee93216f..a31e304c 100644 --- a/readme.md +++ b/readme.md @@ -195,7 +195,7 @@ $ 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. ``` $ tb -c 1 3 @@ -203,7 +203,7 @@ $ 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. ``` $ tb -s 1 2 3 @@ -211,7 +211,7 @@ $ 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. ``` $ tb @@ -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: ``` $ tb -l myboard pending