Add documentation for Todoist component#3283
Merged
Merged
Conversation
6 tasks
Landrash
added
the
new-integration
frenck
requested changes
Aug 31, 2017
| - **custom_projects** (*Optional*): Details on any "custom" binary sensor projects you want to create. | ||
| - **name** (*Required*): The name of your custom project. Only required if you specify that you want to create a custom project. | ||
| - **due_date_days** (*Optional*): Only include tasks due within this many days. If you don't have any tasks with a due date set, this returns nothing. | ||
| - **labels** (*Optional*): Any labels you want to filter for. All tasks in this sensor will include this label. |
Member
There was a problem hiding this comment.
Spelling & Grammar:
forneeds to go. ->Any labels you want to filter.
Alternatively, you could replace the whole description with:Only include tasks which have this label
Unclear documentation:
- If I set two labels, will the tasks actually need to have both? (is it AND or OR?)
|
|
||
| - A project containing *all* the tasks on this account due within the next week. | ||
|
|
||
| - A projct containing everything with the label "Homework", taking only 2 projects into account. |
Member
There was a problem hiding this comment.
Spelling & Grammar:
projct->project
|
|
||
| ### {% linkable_title Services %} | ||
|
|
||
| Todoist also comes with access to a service, `todoist.new_task`. This service can be used to create a new Todoist task. You can specify labels and a project, or you can leave them blank and the task will go to your "Inbox" project. |
Member
There was a problem hiding this comment.
Spelling & Grammar:
- Missing comma after
blank->or you can leave them blank, and the task
|
|
||
| - **labels** (*Optional*): Any labels you want to add to the task, separated by commas. | ||
|
|
||
| - **priority** (*Optional*): The priority of the task, from 1-4. Again, 1 means least important and 4 means most important. |
Member
There was a problem hiding this comment.
Spelling & Grammar:
- Missing coma after
important->means least important, and 4 means
| --- | ||
| layout: page | ||
| title: "Todoist" | ||
| description: "Instructions how to integrate Todoist into Home Assistant." |
Member
There was a problem hiding this comment.
Spelling & Grammar:
Instructions how to integrate->Instructions on how to integrate
Contributor
Author
|
@frenck That's what I get for writing documentation at 3 AM. Your changes should be live now. |
frenck
approved these changes
Sep 2, 2017
Member
|
@Jay2645 hehe, that sounds familiar 🤣 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Description:
This is the documentation for the Todoist component that I've been working on.
Pull request in home-assistant (if applicable): home-assistant/core#9236