-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation fixes & additions #7982
Open
Daraan
wants to merge
13
commits into
carla-simulator:dev
Choose a base branch
from
Daraan:doc-fixes
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains 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
Daraan
force-pushed
the
doc-fixes
branch
2 times, most recently
from
August 1, 2024 14:14
db69c0c
to
9f33baf
Compare
inverse_transform from carla-simulator#7999 highlighted in-place character
- removed deprecated frame_count from example - also exposed WorldSnapshot.elapsed_seconds
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_listening
property. 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_sensors
was not declared as default valueWorld.[try_]spawn_actor
parameter is namedattachment_type
and notattachment
Transform.inverse_transform
from Added inverse transform #7999Needs 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:
#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 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.docs
not includedThis change is