fix: typo in parameter documentation for overwrite#557
Merged
sloretz merged 1 commit intoros2:rollingfrom Apr 22, 2026
Merged
Conversation
Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
christophebedard
approved these changes
Apr 22, 2026
Member
|
Pulls: #557
|
Member
|
@sloretz I assume it's fine to merge this documentation fix during the freeze? |
Member
|
not sure why the CI job badges above aren't updating, but all jobs passed. |
sloretz
approved these changes
Apr 22, 2026
Contributor
sloretz
left a comment
sloretz
left a comment
There was a problem hiding this comment.
Yup, documentation fixing is fine post-freeze
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Fixes a typo I discovered while reviewing ros2/rmw_fastrtps#872
The behavior of the
overwriteparameter inrcutils_set_env_overwriteis what one would expect:truemeans change value if variable was already setfalsemeans keep value if variable was already setSurprisingly, the documentation said the opposite.
Is this user-facing behavior change?
No, but it fixes the documentation to the actual behavior.
Did you use Generative AI?
No
Additional Information
Backporting probably makes sense.