ros-controls / ros2_control_demos

This repository aims at providing examples to illustrate ros2_control and ros2_controllers
https://control.ros.org
Apache License 2.0
374 stars 178 forks source link

Renaming of examples #382

Open Nils-ChristianIseke opened 8 months ago

Nils-ChristianIseke commented 8 months ago

I would prefer it if one could deduce the purpose of the example from the name of the example.

My first suggestion, would look like that:

1_Position_Control_RRBot
2_Diff_Drive_DiffBot
3_Multi_Interfaces_RRBot
4_Integrated_Sensor_RRBot
5_External_Sensor_RRBot
6_Individual_Actuator_Communication_Modular_Robot
7_6DOF_Robot
8_Transmission_Interface_RRBot
9_Gazebo_Sim_Classic_RRBot
10_GPIO_Interfaces_RRBot
12_Chaining_Controllers_RRBot

If you have other naming ideas feel free to share them.

christophfroehlich commented 8 months ago

We discussed this shortly when we reorganized this repository. But back then it was easier to just give them numbers.

If we rename it, I'd rename the folders and package names equally. Can ROS packages start with a number? I don't think so: https://ros.org/reps/rep-0144.html#id11

christophfroehlich commented 8 months ago

But they are not really building on top of each other, maybe the numbers are not necessary at all.

Nils-ChristianIseke commented 8 months ago

We discussed this shortly when we reorganized this repository. But back then it was easier to just give them numbers.

If we rename it, I'd rename the folders and package names equally. Can ROS packages start with a number? I don't think so: https://ros.org/reps/rep-0144.html#id11

Yes right :p, my fault.

Not sure if numbers are necessary, i just kept them. I prefer no numbers at all :)

olivier-stasse commented 2 months ago

Thanks for raising the question.

As a counter argument, I would argue that before we had no numbers and it was orderd alphabetically which is not good either because there is some increasing level of difficulty.

This is not so well reflected in the numbering. But coming back to a none numbered set of examples we will run into another presentation problem. So i would suggest a prefix: Ex_Nb which gives:

Ex_1_Position_Control_RRBot
Ex_2_Diff_Drive_DiffBot
Ex_3_Multi_Interfaces_RRBot
Ex_4_Integrated_Sensor_RRBot
Ex_5_External_Sensor_RRBot
Ex_6_Individual_Actuator_Communication_Modular_Robot
Ex_7_6DOF_Robot
Ex_8_Transmission_Interface_RRBot
Ex_9_Gazebo_Sim_Classic_RRBot
Ex_10_GPIO_Interfaces_RRBot
Ex_12_Chaining_Controllers_RRBot
christophfroehlich commented 3 days ago

Fyi once #417 can be merged I'm open for renaming. Some examples have the same robot and controllers, but only different hardware component structure (ex 1, 3, 6, 14). Maybe we can restructure that a bit and add Ex_1a, Ex_1b, etc. Any suggestions?