Skip to content

doc: contrib/doc/guidelines: use proper role in C docs XREF example#107844

Merged
aescolar merged 1 commit intozephyrproject-rtos:mainfrom
mathieuchopstm:topic/fix_doc_guidelines_example
Apr 24, 2026
Merged

doc: contrib/doc/guidelines: use proper role in C docs XREF example#107844
aescolar merged 1 commit intozephyrproject-rtos:mainfrom
mathieuchopstm:topic/fix_doc_guidelines_example

Conversation

@mathieuchopstm
Copy link
Copy Markdown
Contributor

The example uses :c:func: but the plaintext uses :c:function: instead, which doesn't even exist.

Use proper role in the plaintext for the example.

The example uses `:c:func:` but the plaintext uses `:c:function:` instead,
which doesn't even exist.

Use proper role in the plaintext for the example.

Signed-off-by: Mathieu Choplain <mathieu.choplain-ext@st.com>
@mathieuchopstm mathieuchopstm added the Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc. label Apr 23, 2026
@zephyrbot zephyrbot added area: Documentation size: XS A PR changing only a single line of code labels Apr 23, 2026
@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown
Member

@kartben kartben left a comment

Choose a reason for hiding this comment

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

🫣

@aescolar aescolar merged commit 2e7d5f0 into zephyrproject-rtos:main Apr 24, 2026
24 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: Documentation size: XS A PR changing only a single line of code Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants