Skip to content

Fix rendering problems on Music Assistant page #38674

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

Merged
merged 2 commits into from
Apr 22, 2025

Conversation

OzGav
Copy link
Contributor

@OzGav OzGav commented Apr 22, 2025

Proposed change

Recent update to the docs has some rendering issues with the templates. This will hopefully fix those.

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).
  • 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:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • 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.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Updated YAML script examples for Music Assistant integration to use inline formatting with Jinja raw tags, improving readability without altering functionality.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Apr 22, 2025
Copy link

netlify bot commented Apr 22, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 653ca0b
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6807abbdc4440f0008043788
😎 Deploy Preview https://deploy-preview-38674--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.

@OzGav OzGav changed the title Update music_assistant.markdown Fix rendering problems on Music Assistant page Apr 22, 2025
Copy link
Contributor

coderabbitai bot commented Apr 22, 2025

📝 Walkthrough

Walkthrough

The documentation for the Music Assistant integration has been updated to modify the formatting of YAML script examples. Specifically, the data fields in service calls and actions have been changed from multi-line mappings to single-line inline mappings. The Jinja template expressions within these fields are now wrapped using {% raw %} and {% endraw %} delimiters. There are no changes to the logic, keys, or values—only the YAML formatting and template wrapping have been altered.

Changes

File Change Summary
source/_integrations/music_assistant.markdown Reformatted YAML script examples: changed data fields from multi-line to single-line inline with {% raw %}/{% endraw %} delimiters for Jinja templates.

📜 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 ee30aa4 and 653ca0b.

📒 Files selected for processing (1)
  • source/_integrations/music_assistant.markdown (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • source/_integrations/music_assistant.markdown
⏰ 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

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.

❤️ 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.
  • @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: 0

🧹 Nitpick comments (2)
source/_integrations/music_assistant.markdown (2)

223-224: Improve Clarity of Jinja Raw Tag Placement
Wrapping the entire media_id line in {% raw %}/{% endraw %} works, but relocating the raw markers to surround only the Jinja expression keeps indentation clean and improves readability. For example:

 data:
-  {% raw %}
-  media_id: "{{ random_tracks['items'] | map(attribute='uri') | list }}" {% endraw %}
+  media_id: {% raw %}"{{ random_tracks['items'] | map(attribute='uri') | list }}"{% endraw %}
   media_type: track
   enqueue: replace

256-257: Consolidate Raw Tags Around the Jinja Value
Currently the raw block is opened at the end of the entity_id line, which can be confusing. It’s clearer to leave entity_id untouched and wrap only the templated value:

   data:
-    entity_id: input_text.now_playing {% raw %}
-    value: "{{ queue_info['media_player.ma_kitchen_speaker'].current_item.name }}" {% endraw %}
+    entity_id: input_text.now_playing
+    value: {% raw %}"{{ queue_info['media_player.ma_kitchen_speaker'].current_item.name }}"{% endraw %}

This keeps the raw directive focused on the Jinja expression and maintains valid YAML indentation.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ecb41de and ee30aa4.

📒 Files selected for processing (1)
  • source/_integrations/music_assistant.markdown (2 hunks)
⏰ 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/music_assistant.markdown (1)

223-224: AI Summary Mismatch: Inline vs Multi-line Mapping
The AI-generated summary says the data blocks were converted to single-line inline mappings, but the actual diff shows they remain multi-line mappings with {% raw %}/{% endraw %} wrapping the media_id line. Please update the summary to accurately reflect the change or adjust the snippet to use an inline mapping if that was the intent.

Likely an incorrect or invalid review comment.

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @OzGav 👍

@c0ffeeca7 c0ffeeca7 merged commit 163103c into home-assistant:current Apr 22, 2025
7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 23, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants