home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Published 20 hours ago • verified publisher icon home-assistant

Add documentation for new_task description field.

Open dsymonds opened this issue 9 months ago • 2 comments

Proposed change

Documentation for home-assistant/core#116203.

Type of change

  • [ ] Spelling, grammar or other readability improvements (current branch).
  • [ ] Adjusted missing or incorrect information in the current documentation (current branch).
  • [ ] Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • [x] Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • [ ] Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase: home-assistant/core#116203
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • [x] This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • [x] The documentation follows the Home Assistant documentation standards.

dsymonds avatar Apr 26 '24 02:04 dsymonds

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

home-assistant[bot] avatar Apr 26 '24 02:04 home-assistant[bot]

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit d4ab5870bc5a4837a2c7fd7f777afe13f23fd4c4
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66726459f68d6c0008224680
Deploy Preview https://deploy-preview-32466--home-assistant-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Apr 26 '24 02:04 netlify[bot]

Walkthrough

Walkthrough

This change adds a new optional field called description to the JSON payload for creating tasks in Todoist. Previously, the payload included fields such as content, project, and labels. This new description field allows users to provide a more detailed explanation of the task, enhancing the flexibility and usability of task creation in Todoist.

Changes

Files Change Summary
source/_integrations/todoist... Added an optional description field in the JSON payload for creating tasks.
Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 3d27c8bbc2dbecfb2bcfad0edb3a3eba37643cac and d4ab5870bc5a4837a2c7fd7f777afe13f23fd4c4.

Files selected for processing (1)
  • source/_integrations/todoist.markdown (1 hunks)
Additional context used
LanguageTool
source/_integrations/todoist.markdown

[grammar] ~32-~32: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? (TO_DO_HYPHEN) Context: ...oist projects](https://todoist.com) as todo or [calendar](/in...

[grammar] ~32-~32: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? (TO_DO_HYPHEN) Context: ... projects](https://todoist.com) as todo or [calendar](/integrations/calendar/...

[uncategorized] ~35-~35: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) Context: ...ff` if all the tasks in the project are completed or if the project doesn't have any task...

[style] ~52-~52: Consider using a more formal alternative. (MORE_INFO) Context: ...to access your projects. Above you have more info about it. required: true type: stri...

[typographical] ~53-~53: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...s. Above you have more info about it. required: true type: string custom_projects: ...

[typographical] ~57-~57: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...y sensor projects you want to create. required: false type: list keys: name: ...

[typographical] ~62-~62: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... want to create a custom project. required: true type: string due_date_d...

[typographical] ~66-~66: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...e date set, this returns nothing. required: false type: integer include_...

[typographical] ~70-~70: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...l other projects will be ignored. required: false type: list labels: ...

[typographical] ~74-~74: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...this works as an or statement). required: false type: list {% endconfigura...

[misspelling] ~76-~76: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... required: false type: list {% endconfiguration %} Here's an example of a more advance...

[misspelling] ~113-~113: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... the all_tasks array (see below). {% enddetails %} ## To-do list entity See the [todo...

[grammar] ~117-~117: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? (TO_DO_HYPHEN) Context: ...ails %} ## To-do list entity See the todo integration for d...

[grammar] ~117-~117: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? (TO_DO_HYPHEN) Context: ... %} ## To-do list entity See the todo integration for details on how to man...

[typographical] ~128-~128: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...I. ## Calendar entity attributes - offset_reached: Not used. - all_day: `...

[typographical] ~130-~130: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... - offset_reached: Not used. - all_day: True if the reported task does...

[typographical] ~132-~132: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...alse` if there is a due date set. - message: The title of the "most important" ta...

[typographical] ~134-~134: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ..." task coming up in this project. - description: A URL pointing to the task on the To...

[typographical] ~136-~136: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... the task on the Todoist website. - location: Not used. - start_time: The la...

[typographical] ~138-~138: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...site. - location: Not used. - start_time: The last time the Todoist integ...

[typographical] ~140-~140: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...ually within the last 15 minutes. - end_time: When the task is due. - **all_...

[typographical] ~142-~142: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...end_time*: When the task is due. - all_tasks: A list of all tasks in this pr...

[typographical] ~144-~144: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...most important to least important. - priority: The priority Todoist reports this ta...

[typographical] ~146-~146: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... are displayed in the Todoist app! - task_comments: Any comments added to this ...

[typographical] ~148-~148: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...: Any comments added to this task. - task_labels: All labels associated with th...

[typographical] ~150-~150: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... labels associated with this task. - overdue: Whether the reported task is past it...

[misspelling] ~152-~152: Did you mean to use the verb “do”? (CONFUSION_DUE_DO) Context: ...eported task is past its due date. - due_today: Whether the reported task is d...

[grammar] ~156-~156: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? (TO_DO_HYPHEN) Context: ...ces You may use the services from the todo integration for c...

[grammar] ~156-~156: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? (TO_DO_HYPHEN) Context: ... You may use the services from the todo integration for creating, updating, o...

[misspelling] ~159-~159: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... also comes with an additional service, todoist.new_task that offers more advanced att...

[grammar] ~164-~164: Did you mean “examples”? (ARE_CD_NN) Context: ...o your Inbox project. Here are two example JSON payloads resulting in the same tas...

[typographical] ~187-~187: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...0", "due_date_lang":"en" } ``` - content (Required): The name of the task yo...

[typographical] ~189-~189: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...me of the task you want to create. - description (Optional): A description of the ta...

[typographical] ~191-~191: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...onal*): A description of the task. - project (Optional): The project to put the ...

[typographical] ~193-~193: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...): The project to put the task in. - labels (Optional): Any labels you want to ...

[typographical] ~195-~195: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... to the task, separated by commas. - assignee (Optional): A member's username of ...

[typographical] ~197-~197: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...borator menu of a shared project. - priority (Optional): The priority of the tas...

[misspelling] ~199-~199: Did you mean to use the verb “do”? (CONFUSION_DUE_DO) Context: ...rtant, and 4 means most important. - due_date_string (Optional): When the ta...

[misspelling] ~201-~201: Did you mean to use the verb “do”? (CONFUSION_DUE_DO) Context: ...Mutually exclusive with due_date - due_date_lang (Optional): When `due_dat...

[misspelling] ~201-~201: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...exclusive with due_date - due_date_lang (Optional): When due_date_string ...

[misspelling] ~202-~202: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... language. Valid languages are: en, da, pl, zh, ko, de, pt, ja, `...

[misspelling] ~202-~202: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... Valid languages are: en, da, pl, zh, ko, de, pt, ja, it, fr, `...

[misspelling] ~202-~202: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... languages are: en, da, pl, zh, ko, de, pt, ja, it, fr, sv, `...

[misspelling] ~202-~202: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ages are: en, da, pl, zh, ko, de, pt, ja, it, fr, sv, ru, `...

[misspelling] ~202-~202: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...n, da, pl, zh, ko, de, pt, ja, it, fr, sv, ru, es, nl` -...

[misspelling] ~202-~202: Make sure that ‘fr’ means ‘franc’. Did you mean “for”? (FR) Context: ...l, zh, ko, de, pt, ja, it, fr, sv, ru, es, nl` - *due_date...

[misspelling] ~202-~202: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...h, ko, de, pt, ja, it, fr, sv, ru, es, nl` - due_date (*Op...

[misspelling] ~202-~202: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...o, de, pt, ja, it, fr, sv, ru, es, nl` - due_date (*Optional...

[misspelling] ~202-~202: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...e, pt, ja, it, fr, sv, ru, es, nl` - due_date (Optional): Wh...

[misspelling] ~204-~204: Did you mean to use the verb “do”? (CONFUSION_DUE_DO) Context: ...it, fr, sv, ru, es, nl - due_date (Optional): When the task shou...

[typographical] ~206-~206: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... exclusive with due_date_string. - reminder_date_string (Optional): When shoul...

[typographical] ~208-~208: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...lly exclusive with reminder_date - reminder_date_lang (Optional): When `reminde...

[misspelling] ~208-~208: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...with reminder_date - reminder_date_lang (Optional): When `reminder_date_str...

[misspelling] ~209-~209: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... language. Valid languages are: en, da, pl, zh, ko, de, pt, ja, `...

[misspelling] ~209-~209: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... Valid languages are: en, da, pl, zh, ko, de, pt, ja, it, fr, `...

[misspelling] ~209-~209: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... languages are: en, da, pl, zh, ko, de, pt, ja, it, fr, sv, `...

[misspelling] ~209-~209: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ages are: en, da, pl, zh, ko, de, pt, ja, it, fr, sv, ru, `...

[misspelling] ~209-~209: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...n, da, pl, zh, ko, de, pt, ja, it, fr, sv, ru, es, nl` -...

[misspelling] ~209-~209: Make sure that ‘fr’ means ‘franc’. Did you mean “for”? (FR) Context: ...l, zh, ko, de, pt, ja, it, fr, sv, ru, es, nl` - **reminder_...

[misspelling] ~209-~209: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...h, ko, de, pt, ja, it, fr, sv, ru, es, nl` - reminder_date...

[misspelling] ~209-~209: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...o, de, pt, ja, it, fr, sv, ru, es, nl` - reminder_date (*Opt...

[misspelling] ~209-~209: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...e, pt, ja, it, fr, sv, ru, es, nl` - reminder_date (Optional...

Markdownlint
source/_integrations/todoist.markdown

142-142: Expected: 1; Actual: 0 (MD005, list-indent) Inconsistent indentation for list items at the same level

144-144: Expected: 1; Actual: 0 (MD005, list-indent) Inconsistent indentation for list items at the same level

146-146: Expected: 1; Actual: 0 (MD005, list-indent) Inconsistent indentation for list items at the same level

148-148: Expected: 1; Actual: 0 (MD005, list-indent) Inconsistent indentation for list items at the same level

150-150: Expected: 1; Actual: 0 (MD005, list-indent) Inconsistent indentation for list items at the same level

152-152: Expected: 1; Actual: 0 (MD005, list-indent) Inconsistent indentation for list items at the same level

128-128: Expected: 0; Actual: 1 (MD007, ul-indent) Unordered list indentation

130-130: Expected: 0; Actual: 1 (MD007, ul-indent) Unordered list indentation

132-132: Expected: 0; Actual: 1 (MD007, ul-indent) Unordered list indentation

134-134: Expected: 0; Actual: 1 (MD007, ul-indent) Unordered list indentation

136-136: Expected: 0; Actual: 1 (MD007, ul-indent) Unordered list indentation

138-138: Expected: 0; Actual: 1 (MD007, ul-indent) Unordered list indentation

140-140: Expected: 0; Actual: 1 (MD007, ul-indent) Unordered list indentation

195-195: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces

34-34: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines

Additional comments not posted (3)
source/_integrations/todoist.markdown (3)

189-190: The addition of the description field is well-documented and aligns with the PR's objectives to enhance task creation features in Todoist integration.

Tools
LanguageTool

[typographical] ~189-~189: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...me of the task you want to create. - description (Optional): A description of the ta...

Line range hint 52-76: Ensure that the YAML configuration examples are clear and follow the latest Home Assistant configuration standards. Consider adding comments within the YAML to guide new users.

Verification successful

The extracted content around lines 55 and 85 in source/_integrations/todoist.markdown confirms that the provided snippet is consistent with the configuration format and descriptions in the file. The configuration examples and descriptions are accurate and follow the expected YAML structure for Home Assistant integrations.

  • Lines 50-60 show the configuration details for token and custom_projects as described in the snippet.
  • Lines 80-90 provide an example configuration in configuration.yaml that aligns with the described structure.

Therefore, the provided review comment is accurate and consistent with the rest of the file.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for updates to Home Assistant configuration standards that might affect the Todoist integration.

# Test: Search for recent changes in configuration standards.
cat docs/configuration_standards.md | grep -A 5 "Todoist"

Length of output: 121

Script:

#!/bin/bash
# Search for configuration examples related to Todoist in the repository.

# Find files related to Todoist integration
fd -e markdown -e md -e yaml -e yml -e txt -i todoist

# Search for configuration examples within the identified files
fd -e markdown -e md -e yaml -e yml -e txt -i todoist --exec grep -Hn "custom_projects"

Length of output: 305

Script:

#!/bin/bash
# Extract and review the content around lines 55 and 85 in the source/_integrations/todoist.markdown file.

# Display lines around the first occurrence (line 55)
sed -n '50,60p' source/_integrations/todoist.markdown

# Display lines around the second occurrence (line 85)
sed -n '80,90p' source/_integrations/todoist.markdown

Length of output: 693

Tools
LanguageTool

[typographical] ~187-~187: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...0", "due_date_lang":"en" } ``` - content (Required): The name of the task yo...

[typographical] ~189-~189: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...me of the task you want to create. - description (Optional): A description of the ta...

[typographical] ~191-~191: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...onal*): A description of the task. - project (Optional): The project to put the ...

[typographical] ~193-~193: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...): The project to put the task in. - labels (Optional): Any labels you want to ...

Line range hint 156-209: The service documentation provides clear examples of how to interact with the Todoist API. Verify that all service endpoints are up-to-date and match the current capabilities of the Todoist API.

Tools
LanguageTool

[typographical] ~187-~187: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...0", "due_date_lang":"en" } ``` - content (Required): The name of the task yo...

[typographical] ~189-~189: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...me of the task you want to create. - description (Optional): A description of the ta...

[typographical] ~191-~191: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...onal*): A description of the task. - project (Optional): The project to put the ...

[typographical] ~193-~193: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...): The project to put the task in. - labels (Optional): Any labels you want to ...

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 19 '24 04:06 coderabbitai[bot]