Documentation fixes & additions#7982
Open
Daraan wants to merge 13 commits intocarla-simulator:ue4-devfrom
Open
Documentation fixes & additions#7982Daraan wants to merge 13 commits intocarla-simulator:ue4-devfrom
Daraan wants to merge 13 commits intocarla-simulator:ue4-devfrom
Conversation
db69c0c to
9f33baf
Compare
c27b3fb to
dad5f5d
Compare
inverse_transform from carla-simulator#7999 highlighted in-place character
- removed deprecated frame_count from example - also exposed WorldSnapshot.elapsed_seconds
Author
|
@PabloVD |
glopezdiest
approved these changes
Jan 7, 2026
Contributor
|
I've accepted the PR. This PR brings many great changes to the docs, so let's merge it first and fix the outdated things on another PR. Thanks you very much for the updates. We'll merge it once the test finish |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Included in this PR are
Doc changes
Rolled back two changes from changed get_required_files docs #7763:
carla.Sensor.is_listeningproperty. See Corrected information that Sensor.is_listening is (currently) a method #7439fixes of spelling mistakes (docstring and documentation)
Corrected wrong literal wrapping instead of linking in
__init__documentation for OpendriveGenerationParametersClient.replay_file: replay_sensorswas not declared as default valueWorld.[try_]spawn_actorparameter is namedattachment_typeand notattachmentTransform.inverse_transformfrom Added inverse transform #7999Needs decision:
TrafficManager.set_boundaries_respawn_dormant_vehicles has no defaultvalues. 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:
#Python API references-># Python API referencesto be correct markdown. I am not sure if this is intentionally or an old oversight, but haven't seen anything where this could be relevanton_world_tick(self, timestamp -> world_snapshot)to better reflect correct API usage.Where has this been tested?
Possible Drawbacks
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.docsnot includedThis change is