Todoist documentation of new features #39437
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for the Todoist integration's task creation action has been updated to include new optional parameters for more precise control over section creation and to support location-based reminders. Additions and clarifications cover section handling, reminder zones, location details, direction of reminder triggers, and specifying users for reminders. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant Todoist
User->>HomeAssistant: Call todoist.new_task with parameters
HomeAssistant->>Todoist: Check if section exists
alt section does not exist and create_section is true/unspecified
HomeAssistant->>Todoist: Create section
end
HomeAssistant->>Todoist: Create new task in section
alt reminder parameters provided
HomeAssistant->>Todoist: Add reminder (zone or location-based)
alt reminder_users specified
HomeAssistant->>Todoist: Assign reminder to specified users
else
HomeAssistant->>Todoist: Assign reminder to authenticated user
end
end
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/todoist.markdown (5)
193-193: Fix article use and punctuation in section description.Add the missing definite article and comma for clarity.
- **section** (*Optional*): The section within the project to add the task to. If section doesn't already exist it will be created (unless `create_section` is `false`). + **section** (*Optional*): The section within the project to add the task to. If the section doesn't already exist, it will be created (unless `create_section` is `false`).🧰 Tools
🪛 LanguageTool
[uncategorized] ~193-~193: You might be missing the article “a” here.
Context: ...thin the project to add the task to. If section doesn't already exist it will be create...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[typographical] ~193-~193: It seems that a comma is missing.
Context: ...the task to. If section doesn't already exist it will be created (unless `create_sect...(IF_COMMA)
195-195: Remove unnecessary comma in create_section description.The comma before
ifis not needed and interrupts flow.- **create_section** (*Optional*): Whether the specified section should be created, if it doesn't already exist. + **create_section** (*Optional*): Whether the specified section should be created if it doesn't already exist.🧰 Tools
🪛 LanguageTool
[typographical] ~195-~195: Usually, there’s no comma before “if”.
Context: ... the specified section should be created, if it doesn't already exist. - labels...(IF_NO_COMMA)
217-219: Use asterisk for emphasis and improve wording.Switch to
*for italics per markdownlint, and tighten phrasing for the note.- _Note that zone name, latitude, longitude, and radius will be shared with Todoist in order to support the reminder._ + *Note that zone name, latitude, longitude, and radius will be shared with Todoist to support location-based reminders.*🧰 Tools
🪛 LanguageTool
[style] ~218-~218: Consider a more concise word here.
Context: ... and radius will be shared with Todoist in order to support the reminder._ - **reminder_lo...(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
218-218: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
218-218: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
228-229: Add explicit subject to reminder_location_direction note.Start the sentence with a clear subject for completeness.
- Can only be set if `reminder_zone` or `reminder_location_name`, `reminder_latitude`, `reminder_longitude`, and `reminder_radius` are set. + This parameter can only be set if `reminder_zone` or `reminder_location_name`, `reminder_latitude`, `reminder_longitude`, and `reminder_radius` are set.🧰 Tools
🪛 LanguageTool
[style] ~228-~228: To form a complete sentence, be sure to include a subject.
Context: ...sent when entering or leaving the zone. Can only be set ifreminder_zoneor `remi...(MISSING_IT_THERE)
231-232: Clarify and correct grammar in reminder_users entry.Fix possessive, streamline phrasing, and reorder for clarity.
- **reminder_users** (*Optional*): A list of member's usernames of a shared project to be reminded of this task. You find the possible usernames formatted as bold text in the collaborator menu of a shared project. If not specified, the user Home Assistant is authenticated as will be reminded. + **reminder_users** (*Optional*): A list of usernames of shared project members to be reminded of this task. You can find these usernames in bold within the collaborator menu of a shared project. If not specified, the authenticated Home Assistant user will be reminded.🧰 Tools
🪛 LanguageTool
[uncategorized] ~231-~231: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...eminder_users** (Optional): A list of member's usernames of a shared project to be r...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~231-~231: Possible missing comma found.
Context: ...t specified, the user Home Assistant is authenticated as will be reminded.(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/todoist.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/todoist.markdown
[uncategorized] ~193-~193: You might be missing the article “a” here.
Context: ...thin the project to add the task to. If section doesn't already exist it will be create...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[typographical] ~193-~193: It seems that a comma is missing.
Context: ...the task to. If section doesn't already exist it will be created (unless `create_sect...
(IF_COMMA)
[typographical] ~195-~195: Usually, there’s no comma before “if”.
Context: ... the specified section should be created, if it doesn't already exist. - labels...
(IF_NO_COMMA)
[style] ~218-~218: Consider a more concise word here.
Context: ... and radius will be shared with Todoist in order to support the reminder._ - **reminder_lo...
(IN_ORDER_TO_PREMIUM)
[style] ~228-~228: To form a complete sentence, be sure to include a subject.
Context: ...sent when entering or leaving the zone. Can only be set if reminder_zone or `remi...
(MISSING_IT_THERE)
[uncategorized] ~231-~231: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...eminder_users** (Optional): A list of member's usernames of a shared project to be r...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~231-~231: Possible missing comma found.
Context: ...t specified, the user Home Assistant is authenticated as will be reminded.
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/todoist.markdown
218-218: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
218-218: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
* Create section if not exists * Add location-based reminders * Specify users to remind
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
source/_integrations/todoist.markdown (8)
193-193: Document default behavior forsectioncreation.
The doc should state the default value ofcreate_section(presumablytrue) when omitted to avoid confusion.
195-195: Specify default forcreate_section.
Clarify thatcreate_sectiondefaults totrueif not explicitly set.
217-219: Clarify mutual exclusivity forreminder_zone.
Explicitly note that settingreminder_zonedisables all coordinate-based parameters (reminder_location_name,reminder_latitude,reminder_longitude,reminder_radius) and vice versa.
220-221: Group coordinate-based reminder parameters.
Indicate thatreminder_location_namemust be used in tandem withreminder_latitude,reminder_longitude, andreminder_radius. Consider referencing them collectively to prevent partial configurations.
222-223: Merge latitude and longitude descriptions.
To reduce verbosity, consider combiningreminder_latitudeandreminder_longitudeinto a single “Location Coordinates” section or nested sub-items.
224-225: Specify units forreminder_radius.
Add the unit of measurement (e.g., meters) to ensure users understand the expected input.
228-229: Clarifyreminder_location_directionrequirements.
The description should state thatreminder_location_directionis valid only when eitherreminder_zoneor all coordinate-based parameters are provided. This avoids ambiguity over partial configurations.
231-231: Improve sentence clarity and fix missing comma.
Rephrase for readability and correct punctuation:- If not specified, the user Home Assistant is authenticated as will be reminded. + If not specified, the authenticated Home Assistant user will be reminded.🧰 Tools
🪛 LanguageTool
[uncategorized] ~231-~231: Possible missing comma found.
Context: ...t specified, the user Home Assistant is authenticated as will be reminded.(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/todoist.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/todoist.markdown
[uncategorized] ~231-~231: Possible missing comma found.
Context: ...t specified, the user Home Assistant is authenticated as will be reminded.
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/todoist.markdown (1)
216-216: Skip blank line insertion.
This change appears to add a blank line; it doesn’t affect documentation content.
Proposed change
Document the following new features:
Nonefor Todoist section: Also to support the use-case of creating a task in a Home Assistant device area; a given device might not be assigned to an area; in that caseNonewill be set forsectionand it will be ignored, as if no section was specified.Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit