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.

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

Remove leading underscore from private fields #354

Merged

Conversation

luca-della-vedova
Copy link
Collaborator

@luca-della-vedova luca-della-vedova commented Dec 5, 2023

In my previous contributions I used the convention of leading underscores for private fields of struct, however this convention is:

A) Not used anywhere else in the codebase, so it is a disconnect.
B) Actively harmful in Rust since it suppresses unused variable warnings.

This PR is just a bit of hygiene to remove that convention and conform to the normal snake_case names that are used throughout the codebase.

Note that one in particular has been left for now in storage for parameter constraints / description as shown in ce2c502. The value is currently unused but will stop being so when parameter services are implemented #342

Signed-off-by: Luca Della Vedova <lucadv@intrinsic.ai>
Signed-off-by: Luca Della Vedova <lucadv@intrinsic.ai>
Copy link
Collaborator

@esteve esteve left a comment

Choose a reason for hiding this comment

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

@esteve esteve merged commit 9082816 into ros2-rust:main Dec 5, 2023
3 checks passed
@luca-della-vedova luca-della-vedova deleted the luca/remove_leading_underscore branch December 19, 2023 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants