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

doc: Documentation issue in 'services/retention/index' #84340

Open
bbbakke opened this issue Jan 21, 2025 · 2 comments
Open

doc: Documentation issue in 'services/retention/index' #84340

bbbakke opened this issue Jan 21, 2025 · 2 comments
Assignees
Labels
area: Documentation area: Retention bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug

Comments

@bbbakke
Copy link

bbbakke commented Jan 21, 2025

Part of the example code in the documentation is given as:

#include <zephyr/device.h>
#include <zephyr/retention/retention.h>

const struct device *retention1 = DEVICE_DT_GET(DT_NODELABEL(retention1));
const struct device *retention2 = DEVICE_DT_GET(DT_NODELABEL(retention2));

and I think it should be:

#include <zephyr/device.h>
#include <zephyr/retention/retention.h>

const struct device *retention0 = DEVICE_DT_GET(DT_NODELABEL(retention0));
const struct device *retention1 = DEVICE_DT_GET(DT_NODELABEL(retention1));

At least this would then match the devicetree example given just before this code snippet.

Environment

  • Page: services/retention/index
  • Version: main
  • SHA-1: 365a6f5
Copy link

Hi @bbbakke! 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
Copy link
Collaborator

kartben commented Jan 22, 2025

Thanks for taking the time to report this @bbbakke !
A pull request fixing this would be most welcome :) please check our contribution guide as you may be tempted to make the PR directly through GitHub UI and that would most likely cause issues with some of our compliance checks then failing.
Thanks again!

@kartben kartben added bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug labels Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation area: Retention bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Projects
None yet
Development

No branches or pull requests

3 participants