Skip to content

Commit cf855f3

Browse files
michalpelkapeci1
andauthored
Apply suggestions from code review
Co-authored-by: Martin Pecka <peci1@seznam.cz>
1 parent ffdec5b commit cf855f3

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

srv/BatchSpawnEntities.srv

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@ string names[] # A list of names given to every entity
1010
# error is returned.
1111
bool allow_renaming[] # Determines whether the spawning succeeds with a non-unique name.
1212
# If it is set to true, the user should always check entity_name response field
13-
# and use it for any further interactions. Number of elements have to match Number
13+
# and use it for any further interactions. Number of elements has to match number
1414
# of elements in names.
1515

1616
Resource entity_resources[] # List of resources such as SDFormat, URDF, USD or MJCF file, a native prefab, etc.
1717
# Valid URIs can be determined by calling GetSpawnables first.
1818
# Check simulator format support via the spawn_formats field in GetSimulatorFeatures.
1919
# Using resource_string is supported if GetSimulatorFeatures includes
20-
# the SPAWNING_RESOURCE_STRING feature. Number of elements have to match Number
20+
# the SPAWNING_RESOURCE_STRING feature. Number of elements has to match number
2121
# of elements in names.
2222

23-
string entity_namespaces[] # Spawn entities with theirs interfaces under those namespaces. Number of elements have to match Number
23+
string entity_namespaces[] # Spawn entities with theirs interfaces under those namespaces. Number of elements has to match number
2424
# of elements in names.
2525
geometry_msgs/PoseStamped initial_poses[] # Array of initial poses for every enttiy.
2626
# The header contains a reference frame, which defaults to global "world" frame.
2727
# This frame must be known to the simulator, e.g. of an object spawned earlier.
28-
# The timestamp field in the header is ignored. Number of elements have to match Number
28+
# The timestamp field in the header is ignored. Number of elements has to match number
2929
# of elements in names.
3030

3131
---
@@ -36,7 +36,9 @@ uint8 BATCH_SPAWN_MISMATCH = 110 # There is a mismatch in number of eleme
3636
# entity_namespaces, initial_poses.
3737
uint8 BATCH_SPAWN_FAILED = 120 # There was at least one failed spawn request. Check individual results in results.
3838

39-
Result result # If all spawning request succeeded it will give RESULT_OK or BATCH_SPAWN_FAILED
40-
Result results[] # Individual spawn request results. Supported return codes are in SpanwEntity.srv.
39+
Result result # RESULT_OK if all spawning requests succeeded, otherwise BATCH_SPAWN_FAILED
40+
Result results[] # Individual spawn request results. Supported return codes are in SpawnEntity.srv.
41+
# Number of elements is the same as the number of names in request.
4142
string entity_names[] # List of names of spawned entities, guaranteed to be unique in the simulation.
4243
# If allow_renaming is true, it may differ from the request name field.
44+
# Number of elements is the same as the number of names in request.

0 commit comments

Comments
 (0)