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.

Sign up for GitHub

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

Jump to bottom

Deprecated documentation? #19667

Closed
libf-de opened this issue May 25, 2023 · 4 comments · Fixed by #19681
Closed

Deprecated documentation? #19667

libf-de opened this issue May 25, 2023 · 4 comments · Fixed by #19681
Assignees
@maribu
Labels
Area: doc Area: Documentation Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)

Comments

@libf-de
Copy link

libf-de commented May 25, 2023

As discussed in person, the documentation refers to the deprecated xtimer under "Timers" (https://api.riot-os.org/group__sys__xtimer.html) instead of ztimer
@maribu maribu added Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) Area: doc Area: Documentation labels May 30, 2023
@maribu maribu self-assigned this May 30, 2023
@maribu maribu mentioned this issue May 30, 2023
Merged
@bors bors bot closed this as completed in #19681 May 30, 2023
@miri64 miri64 reopened this May 30, 2023
@miri64
Copy link
Member

miri64 commented May 30, 2023

While #19681 points out that xtimer is deprecated, xtimer is still the API being listed when clicking at https://doc.riot-os.org/ on Modules > System > Timers, which was what @libf-de wanted to point out.

@miri64
Copy link
Member

miri64 commented May 30, 2023

Sorry, that I only realized that now.

@miri64
Copy link
Member

miri64 commented May 30, 2023

Or is https://doc.riot-os.org/ just not updated yet?

@miri64
Copy link
Member

miri64 commented May 30, 2023

Nvm, confirmed that https://ci.riot-os.org/results/552f671f036e4b7c98913d18fd624a66/doc-preview/ shows the expected TOC.

@miri64 miri64 closed this as completed May 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@maribu maribu

Labels
Area: doc Area: Documentation Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

sys/xtimer: improve documentation maribu/RIOT
3 participants
@miri64 @maribu @libf-de