Minor updates to readme.md and contributing.md #29
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ### 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. |
| - 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: |
| ### 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. |
Owner
There was a problem hiding this comment.
I think it should be: to its opposite value, since it is just a single status that is updated for each item.
| ### 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. |
Owner
There was a problem hiding this comment.
This one could just be completely simplified to:
The functionality of this option is the same as the one of `--check`/`-c`.
| ### 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. |
| ### 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: |
Owner
There was a problem hiding this comment.
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,
klaudiosinani
requested changes
Aug 6, 2018
Owner
klaudiosinani
left a comment
klaudiosinani
left a comment
There was a problem hiding this comment.
A couple of tweaks and it is good to go. Thank you for taking the time to propose the improvements : )
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor changes to readme.md
check taskstar itemdisplay boardslist itemsMinor changes to contributing.md
couldtowould