Skip to content
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
wants to merge 13 commits into
base: dev
Choose a base branch
from
Open

Conversation

Daraan
Copy link
Contributor

@Daraan Daraan commented Jul 24, 2024

Description

Included in this PR are

Doc changes

  1. Rolled back two changes from changed get_required_files docs #7763:

    1. 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 
    2. Removed the accidentally re added reference to the removed carla.Sensor.is_listening property. See Corrected information that Sensor.is_listening is (currently) a method #7439
  2. fixes of spelling mistakes (docstring and documentation)

  3. 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)).

  1. Added Missing __init__ documentation for OpendriveGenerationParameters
  2. Client.replay_file: replay_sensors was not declared as default value
  3. World.[try_]spawn_actor parameter is named attachment_type and not attachment
  4. Added documentation for Transform.inverse_transform from Added inverse transform #7999
  5. added WorldSnapshot.elapsed_seconds to API description.
  6. 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:

  1. 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
  2. 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


This change is Reviewable

@Daraan Daraan requested a review from a team as a code owner July 24, 2024 16:48
@Daraan Daraan force-pushed the doc-fixes branch 2 times, most recently from db69c0c to 9f33baf Compare August 1, 2024 14:14
@Daraan Daraan mentioned this pull request Aug 1, 2024
@Daraan Daraan changed the title Documentation fixes Documentation fixes & additions Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant