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

Rename custom_params to custom_keys #186

Open
Minipada opened this issue May 22, 2023 · 4 comments
Open

Rename custom_params to custom_keys #186

Minipada opened this issue May 22, 2023 · 4 comments
Assignees
Labels
enhancement New feature or request good first issue Want to contribute, start with this! measurement Measurement node

Comments

@Minipada
Copy link
Owner

Minipada commented May 22, 2023

This task consists in renaming:

  1. custom_str_param_list to custom_key_str_list node paramter
  2. custom_str_params to custom_keys_str node paramter
  3. All variables with custom_params to custom_key

The documentation of the parameters are located here https://minipada.github.io/ros2_data_collection/dc/measurements.html#node-parameters

The reason to do so is that we are not adding custom parameters but custom keys to the JSON.

To do it, I would suggest to do a Ctrl-F an do search and replace.

They are located in:
https://github.com/Minipada/ros2_data_collection/blob/humble/dc_core/include/dc_core/measurement.hpp
https://github.com/Minipada/ros2_data_collection/blob/humble/dc_measurements/include/dc_measurements/measurement.hpp
https://github.com/Minipada/ros2_data_collection/blob/humble/dc_measurements/include/dc_measurements/measurement_server.hpp
https://github.com/Minipada/ros2_data_collection/blob/humble/dc_measurements/src/measurement_server.cpp

Then we should also rename them in the documentation. To run the documentation locally and see your changes, check the FAQ https://minipada.github.io/ros2_data_collection/dc/contributing.html#docs

@Minipada Minipada converted this from a draft issue May 22, 2023
@Minipada Minipada self-assigned this May 22, 2023
@Minipada Minipada added enhancement New feature or request measurement Measurement node good first issue Want to contribute, start with this! labels May 22, 2023
@Akashutreja
Copy link

Hey @Minipada , can i take this?
please let me know if i need to follow any guidelines for this.

Thanks

@Minipada
Copy link
Owner Author

Hi @Akashutreja , thanks for offering your support, I'll gladly take it. I edited the description in the task and feel free to ping me if you need more help!

@Akashutreja
Copy link

Hey @Minipada ,
I am done with code but while pushing code I am getting below permission error, can you please check this?
remote: Permission to Minipada/ros2_data_collection.git denied to Akashutreja.

@Minipada
Copy link
Owner Author

Great! Please fork, push on your fork and do a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Want to contribute, start with this! measurement Measurement node
Projects
Status: Ready
Development

No branches or pull requests

2 participants