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

add radioactivity_concentration to sensor.markdown #36640

Closed
wants to merge 43 commits into from

Conversation

jcgillespie
Copy link

@jcgillespie jcgillespie commented Jan 1, 2025

Proposed change

Adding documentation for radioactivity_concentration device class that parallels the codebase PR

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).
  • I've opened up a PR to add logos and icons in Brands repository.
  • 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: Codebase PR

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
    • Added a new device class for radioactivity concentration sensors
    • Supports measurement in Bq/m³ or pCi/L
    • Expands sensor type documentation in Home Assistant

mrdarrengriffin and others added 30 commits December 23, 2024 16:13
* Fix display issues when :target is active

* Content update

* Change :target to display block

* Added Australian distributors
* Fix limitations wording

* Reorder limitations section
Bumps [rbs](https://github.com/ruby/rbs) from 3.7.0 to 3.8.0.
- [Release notes](https://github.com/ruby/rbs/releases)
- [Changelog](https://github.com/ruby/rbs/blob/master/CHANGELOG.md)
- [Commits](ruby/rbs@v3.7.0...v3.8.0)

---
updated-dependencies:
- dependency-name: rbs
  dependency-type: indirect
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…36548)

Bumps [bigdecimal](https://github.com/ruby/bigdecimal) from 3.1.8 to 3.1.9.
- [Release notes](https://github.com/ruby/bigdecimal/releases)
- [Changelog](https://github.com/ruby/bigdecimal/blob/master/CHANGES.md)
- [Commits](ruby/bigdecimal@v3.1.8...v3.1.9)

---
updated-dependencies:
- dependency-name: bigdecimal
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…t#36504)

* Add troubleshooting and known limitations

* Remove quotes for non-code

* CRAI nitpicks

* Add suggestions
Example in Legacy binary sensor section was missing quote marks.
Point to the correct repository and not to a forked one.
@home-assistant home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jan 1, 2025
@home-assistant
Copy link

home-assistant bot commented Jan 1, 2025

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.

Copy link

netlify bot commented Jan 1, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit fa587fe
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67758a8d8267300008dff05a
😎 Deploy Preview https://deploy-preview-36640--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.

Copy link
Contributor

coderabbitai bot commented Jan 1, 2025

📝 Walkthrough

Walkthrough

The documentation for the Home Assistant sensor integration has been updated to include a new device class called radioactivity_concentration. This addition allows for representing radioactivity concentration measurements in units of Bq/m³ or pCi/L, expanding the range of sensor types that can be documented within the Home Assistant ecosystem.

Changes

File Change Summary
source/_integrations/sensor.markdown Added new device class radioactivity_concentration for measuring radioactivity concentration

The changes are minimal and focused on enhancing the documentation's device class support for radiation-related sensors.


📜 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 3c03b60 and fa587fe.

📒 Files selected for processing (1)
  • source/_integrations/sensor.markdown (1 hunks)
🔇 Additional comments (1)
source/_integrations/sensor.markdown (1)

88-88: LGTM! The new device class is properly documented.

The addition of the radioactivity_concentration device class is well-formatted, placed in correct alphabetical order, and uses appropriate units (Bq/m³ and pCi/L) that are commonly used for measuring radioactivity concentration, particularly in radon monitoring applications.

Let's verify that this aligns with the implementation in the core repository:


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.

@jcgillespie jcgillespie changed the base branch from current to next January 1, 2025 18:38
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch current This PR goes into the current branch labels Jan 1, 2025
@home-assistant home-assistant bot added the next This PR goes into the next branch label Jan 1, 2025
@jcgillespie jcgillespie closed this Jan 1, 2025
@home-assistant home-assistant bot removed the in-progress This PR/Issue is currently being worked on label Jan 1, 2025
@jcgillespie jcgillespie deleted the patch-1 branch January 1, 2025 18:46
@github-actions github-actions bot locked and limited conversation to collaborators Jan 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.