Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix invalid yaml #2546

Merged
merged 2 commits into from
Feb 3, 2025
Merged

Fix invalid yaml #2546

merged 2 commits into from
Feb 3, 2025

Conversation

brantlk
Copy link
Contributor

@brantlk brantlk commented Jan 29, 2025

Proposed change

The object keys need to be at the same indentation.

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Removed stale or deprecated documentation

Additional information

None

Summary by CodeRabbit

  • Documentation
    • Updated YAML style guide with improved clarity and consistency.
    • Enhanced examples in the "Default values" and "Service action targets" sections.
    • Corrected indentation for the triggers and data fields to align with established standards.

The object keys need to be at the same indentation.
Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

📝 Walkthrough

Walkthrough

The pull request involves updates to the YAML style guide documentation, specifically addressing the "Default values" and "Service action targets" sections. Changes include correcting the indentation of the triggers field to four spaces, adding a condition line to the "Good" example, and adjusting the indentation of the data field in the "Bad" example to ensure consistency. These modifications aim to enhance the clarity and consistency of the YAML documentation.

Changes

File Change Summary
docs/documenting/yaml-style-guide.md - Corrected indentation of triggers field in "Default values" section to 4 spaces
- Added condition line to "Good" example in "Default values" section
- Adjusted indentation of data field in "Bad" example in "Service action targets" section to 4 spaces

Notes

  • No changes to exported or public entity declarations were made.
  • The modifications are purely documentation-related, improving style guide clarity.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fc7f33b and 6e392dd.

📒 Files selected for processing (1)
  • docs/documenting/yaml-style-guide.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/documenting/yaml-style-guide.md

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b2b3f5 and fc7f33b.

📒 Files selected for processing (1)
  • docs/documenting/yaml-style-guide.md (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - developers-home-assistant
  • GitHub Check: Header rules - developers-home-assistant
  • GitHub Check: Pages changed - developers-home-assistant
🔇 Additional comments (2)
docs/documenting/yaml-style-guide.md (2)

314-315: LGTM!

The indentation is correct and consistent with the guide's 2-space rule. The example effectively demonstrates the incorrect way of specifying entity IDs in service calls.


Line range hint 1-600: Documentation is comprehensive and well-structured.

The YAML style guide effectively covers all important aspects of YAML formatting with clear examples. The consistent use of "Good" and "Bad" examples helps readers understand the rules easily.

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft January 30, 2025 16:38
The yaml here was invalid because the items in the object weren't indented at the same level.
There was also a double space after the - list element indicator.
@frenck frenck marked this pull request as ready for review February 3, 2025 11:51
@home-assistant home-assistant bot requested a review from abmantis February 3, 2025 11:51
@abmantis abmantis merged commit a026788 into home-assistant:master Feb 3, 2025
5 checks passed
@abmantis
Copy link
Contributor

abmantis commented Feb 3, 2025

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants