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

Update energy.markdown for detail devices max_devices #31731

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented Mar 4, 2024

Proposed change

Document supported option for energy detail devices graph

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

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.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Mar 4, 2024
Copy link

netlify bot commented Mar 4, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 27ce9e1
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/65e5dd59d84e6600094bd5be
😎 Deploy Preview https://deploy-preview-31731--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.

The **Detail devices energy graph** card is similar to the **Devices energy graph** card, but shows the individual usage on a time scale.
The **Detail devices energy graph** card is similar to the **Devices energy graph** card, but shows the individual usage on a time scale.

By default, this card will show all your devices. Optionally, the number of devices can be limited by adding the `max_devices` option and specifying the maximum number of devices to show. If there are more devices available than shown, the devices with the highest energy usage are shown.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is just a copy-paste of the description of the same option just above for energy devices graph. Is it better to repeat the entire description verbatim, or just say "this supports the same option as energy-devices-graph" ?

Copy link
Contributor

Choose a reason for hiding this comment

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

good question. I would leave it in, as copy. It leaves less room for ambiguity. I realize there are docs maintenance costs to this.

@klaasnicolaas klaasnicolaas added this to the 2024.3 milestone Mar 4, 2024
@frenck frenck added the parent-merged The parent PR has been merged already label Mar 5, 2024
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, @karwosts 👍

@c0ffeeca7 c0ffeeca7 merged commit e1ee16d into next Mar 5, 2024
9 checks passed
@c0ffeeca7 c0ffeeca7 deleted the karwosts-patch-5 branch March 5, 2024 14:24
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Mar 5, 2024
@frenck frenck added the cherry-picked This PR has been manually picked and merged into the current branch label Mar 5, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Mar 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cherry-picked This PR has been manually picked and merged into the current branch has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants