carla
carla copied to clipboard
Documentation fixes & additions
Description
Included in this PR are
Doc changes
-
Rolled back two changes from #7763:
- Re added "identifiers" in this docstring, as the sentence is incomplete currently.
- Defines the of each GBuffer texture (See the method + Defines the identifiers of each GBuffer texture (See the method
- Removed the accidentally re added reference to the removed
carla.Sensor.is_listening
property. See #7439
- Re added "identifiers" in this docstring, as the sentence is incomplete currently.
-
fixes of spelling mistakes (docstring and documentation)
-
Corrected wrong literal wrapping instead of linking in
[old:] Defines the of each GBuffer texture (See the method
[carla.Sensor.listen_to_gbuffer](#carla.Sensor.listen_to_gbuffer)
).
- Added Missing
__init__
documentation for OpendriveGenerationParameters -
Client.replay_file: replay_sensors
was not declared as default value -
World.[try_]spawn_actor
parameter is namedattachment_type
and notattachment
- Added documentation for
Transform.inverse_transform
from #7999 - added WorldSnapshot.elapsed_seconds to API description.
- Fixed missing/wrong parameter for Client.apply_batch[_sync]
Needs decision:
- [ ]
TrafficManager.set_boundaries_respawn_dormant_vehicles has no default
values. Current default values are annotations that describe the bounds but are not really default values. I am not sure how to address this.
Changes in non-documentation files:
- Added space after # Heading when docs are generated
#Python API references
-># Python API references
to be correct markdown. I am not sure if this is intentionally or an old oversight, but haven't seen anything where this could be relevant - Changed in python examples:
on_world_tick(self, timestamp -> world_snapshot)
to better reflect correct API usage.
Where has this been tested?
- Platform(s): Ubuntu
- Python version(s): 3.7 & 3.10 (should be irrelevant)
- Unreal Engine version(s): 4.26
Possible Drawbacks
- Does 4 have any side effects?
Concerning 11): Are there sideeffects to consider with the parameter renaming of def on_world_tick(self, timestamp -> world_snapshot):
in the examples?
Note:
Currently pending changes to snippets and blueprint library (bp_libarary.md) from make PythonAPI.docs
not included