search

zephyrproject-rtos / zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
https://docs.zephyrproject.org
Apache License 2.0
10.33k stars 6.33k forks source link

doc: SCD30 CO2 sensor support documentation inconsistency #68018

Closed pasrom closed 2 months ago

pasrom commented 7 months ago

Describe the bug In the release notes for version 3.3, the Zephyr documentation explicitly lists support for the SCD30 CO2 sensor. https://github.com/zephyrproject-rtos/zephyr/blob/1d23ac55777cf6ad8f7cebebeaf043bc7f9d99ff/doc/releases/release-notes-3.3.rst#L3722 This inconsistency is due to an issue being reported (https://github.com/zephyrproject-rtos/zephyr/issues/39234) and a related pull request being submitted (https://github.com/zephyrproject-rtos/zephyr/pull/39236) for the sensor's integration, but the PR was not merged into the main code base.

Expected behavior The documentation should accurately reflect the hardware support that exists in the code base.

Environment Zephyr Version: >= 3.3

Additional context To resolve this, either the documentation should be updated to reflect the actual state of sensor support, or the sensor support should be integrated into the code. For the latter, an updated driver is available here.

github-actions[bot] commented 7 months ago

Hi @pasrom! We appreciate you submitting your first issue for our open-source project. 🌟

Even though I'm a bot, I can assure you that the whole community is genuinely grateful for your time and effort. 🤖💙

kartben commented 7 months ago

I am not sure how easy this would be to address, as there's definitely more than just the linked release note entry that's bogus, see #57966. Not sure we'd want to amend past release notes, as it is an artefact of a previous release that one would expect to not fluctuate over time. Maybe we should add a notice to all the impacted release notes that links to #57966 to indicate they might not reflect the reality of things that were actually fixed?

pasrom commented 7 months ago

Maybe we should add a notice to all the impacted release notes that links to https://github.com/zephyrproject-rtos/zephyr/issues/57966 to indicate they might not reflect the reality of things that were actually fixed?

This would be a good approach.

github-actions[bot] commented 4 months ago

This issue has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this issue will automatically be closed in 14 days. Note, that you can always re-open a closed issue at any time.

github-actions[bot] commented 2 months ago

This issue has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this issue will automatically be closed in 14 days. Note, that you can always re-open a closed issue at any time.