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

Show descriptions in script editor #20765

Merged
merged 2 commits into from May 13, 2024

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented May 9, 2024

Proposed change

Render the description field for scripts in the editor in the same way that we do for automations.

This would likely benefit from further work to add the description field editor to the UI (in the rename dialog like the automation editor), but for now we can at least show the description for users which have configured it in YAML.

I am also working on moving the script editor to be more like the automation editor as well, in a separate PR.

image

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

@karwosts
Copy link
Contributor Author

Updated for blueprint editors as well.

Changed blueprint-automation-editor from <p> description to <ha-markdown> to match the style of the manual-automation-editor.

Copy link
Member

@piitaya piitaya 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 @karwosts. I was planning to unify the script editor with the automation editor but if you will open a PR I'm fine with that too! I'll review it.

@piitaya piitaya merged commit f5f2a5a into home-assistant:dev May 13, 2024
13 checks passed
@karwosts karwosts deleted the script-descriptions branch May 13, 2024 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants