core/debug: extend doc about DEBUG() / LOG_DEBUG() #21276
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maribu
added
Area: doc
github-actions
bot
added
Area: core
Enoch247
approved these changes
Mar 6, 2025
maribu
added
the
Process: needs >1 ACK
github-actions
bot
added
the
Process: missing approvals
|
While this PR isn't exactly scary, let's have a 2nd ACK as it is touching core. |
crasbe
reviewed
Mar 6, 2025
crasbe
reviewed
Mar 6, 2025
|
One might argue that it would be nicer to write |
|
The generated documentation works now, but the new PR only changes the first IMO you can squash directly and then it's good to merge from my side. |
This adds a few lines to explain the difference between the two and hints when to use which. Co-authored-by: crasbe <[email protected]>
|
Done, should be good now :) |
crasbe
approved these changes
Mar 6, 2025
github-actions
bot
removed
the
Process: missing approvals
|
Thx :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
This adds a few lines to explain the difference between the two and hints when to use which.
Testing procedure
The CI will generate a preview of the doc that can be checked.
Issues/PRs references
None