Fix documentation about struct RData's data field #14221
Merged
Conversation
This file contains hidden or 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
Also adds a static assertion to ensure the documented behavior stays true, namely that the data field is at the same position in the RData and RTypedData structs.
4a01563 to
7b251c8
Compare
This was referenced Aug 14, 2025
|
Do not mix code change into documentation change. |
|
@etiennebarrie Let me explain more context that this PR's commit which caused the CI failures (#14229). Previously, the CI skipped checks when a PR commit's title or message includes "document" (case insensitive), assuming the commit is only modifying the document. However, this PR's commit was using the title including "document", but actually modifying the code, and the PR skipped the CI checks. So, we stopped skipping the CI when the commit title or message include "document" by the 70b4b6f. There is still a logic to skip CI when a commit's title or message includes "[DOC]". But please keep in mind that you do not modify a code, when using the "[DOC]". |
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.
Also adds a static assertion to ensure the documented behavior stays true, namely that the data field is at the same position in the RData and RTypedData structs.
This was changed in 360be94. cc @byroot