search

osrf / ros2multirobotbook

Creative Commons Attribution 4.0 International
123 stars 32 forks source link

Edit: Traffic editor #32

Closed maryaB-osr closed 4 years ago

maryaB-osr commented 4 years ago

Just a couple small questions:

Some ambiguity starting on line 46:

The structure essentially breaks a project into .building.yaml files that may represent various buildings that make up a given site.

I want to remove "essentially" from this sentence. Is the project broken into builidng.yaml files or not?

Also, "...files that may represent..." do you mean the files can represent something other than a building? If they only represent buildings, I'd like to change it to "... into building.yaml files representing various buildings..." if that makes sense.

On line 392:

the demo_mock_floor_name and demo_mock_lift_name properties were

This is the only place where you used bold to indicate a property outside of a list. I'm not sure if this is because it's the only place where properties are mentioned outside of a list. In the "Adding a door" section you wrote the motion_degree and motion_direction properties in backticks. Can you double check the syntax you've used for parameters/properties/property values/etc are consistent for each?

mdfesto commented 4 years ago

@Yadunund you may want to take a look here

Yadunund commented 4 years ago

Just a couple small questions:

Some ambiguity starting on line 46:

The structure essentially breaks a project into .building.yaml files that may represent various buildings that make up a given site.

I want to remove "essentially" from this sentence. Is the project broken into builidng.yaml files or not?

Also, "...files that may represent..." do you mean the files can represent something other than a building? If they only represent buildings, I'd like to change it to "... into building.yaml files representing various buildings..." if that makes sense.

Sorry for the ambiguity. Removing "essentially" and rephrasing as suggested is appropriate.

On line 392:

the demo_mock_floor_name and demo_mock_lift_name properties were

This is the only place where you used bold to indicate a property outside of a list. I'm not sure if this is because it's the only place where properties are mentioned outside of a list. In the "Adding a door" section you wrote the motion_degree and motion_direction properties in backticks. Can you double check the syntax you've used for parameters/properties/property values/etc are consistent for each?

Thanks for pointing this out. I tried to use bold when describing parameters in a list and backticks otherwise as with motion_degree and motion_direction. We can either replace the bolding on line 392 with backticks or change all property references to bold. Which ever you think is more consistent?