Add missing get_transform method to carla.Actor docs section. (#2031)

* Add missing get_transform method to carla.Actor docs section.

* Update contribution guide.
Update PythonAPI YAML docs.
This commit is contained in:
Ferdinand Mütsch 2019-09-02 18:23:33 +02:00 committed by bernat
parent 4edfd65835
commit 4c1c34fd1f
4 changed files with 16 additions and 5 deletions

View File

@ -38,9 +38,11 @@ open an issue to let us know. Even better, if you think you can improve it
yourself, it would be a great contribution to the community!
We build our documentation with [MkDocs](http://www.mkdocs.org/) based on the
Markdown files inside the "Docs" folder. You can either directly modify them on
Markdown files inside the `Docs` folder. You can either directly modify them on
GitHub or locally in your machine.
To update Python API docs, instead of directly modifying the Markdown you need to edit the corresponding YAML files inside `PythonAPI/docs` and run `doc_gen.py` (Python 2) subsequently. This will re-generate the respective Markdown files inside `Docs/`, which can then be fed into `mkdocs`.
Once you are done with your changes, please submit a pull-request.
!!! tip

View File

@ -107,6 +107,7 @@
- [**destroy**(**self**)](#carla.Actor.destroy) <sub>_Method_</sub>
- [**get_world**(**self**)](#carla.Actor.get_world) <sub>_Method_</sub>
- [**get_location**(**self**)](#carla.Actor.get_location) <sub>_Method_</sub>
- [**get_transform**(**self**)](#carla.Actor.get_transform) <sub>_Method_</sub>
- [**get_velocity**(**self**)](#carla.Actor.get_velocity) <sub>_Method_</sub>
- [**get_angular_velocity**(**self**)](#carla.Actor.get_angular_velocity) <sub>_Method_</sub>
- [**get_acceleration**(**self**)](#carla.Actor.get_acceleration) <sub>_Method_</sub>
@ -830,6 +831,9 @@ Returns the current location of the actor.
- **Return:** _[carla.Location](#carla.Location)_
- **Note:** <font color="#8E8E8E">_This function does not call the simulator, it returns the location received in the last tick.
_</font>
- <a name="carla.Actor.get_transform"></a>**<font color="#7fb800">get_transform</font>**(<font color="#00a6ed">**self**</font>)
Returns the current transform of the actor.
- **Return:** _[carla.Transform](#carla.Transform)_
- <a name="carla.Actor.get_velocity"></a>**<font color="#7fb800">get_velocity</font>**(<font color="#00a6ed">**self**</font>)
Returns the current 3D velocity of the actor.
- **Return:** _[carla.Vector3D](#carla.Vector3D)_
@ -1195,10 +1199,10 @@ Height regarding ground level.
- `altitude` (_float_)
- <a name="carla.GeoLocation.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**</font>)
- **Parameters:**
- `other` (_[carla.Geolocation](#carla.Geolocation)_)
- `other` (_[carla.GeoLocation](#carla.GeoLocation)_)
- <a name="carla.GeoLocation.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**</font>)
- **Parameters:**
- `other` (_[carla.Geolocation](#carla.Geolocation)_)
- `other` (_[carla.GeoLocation](#carla.GeoLocation)_)
- <a name="carla.GeoLocation.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
---

View File

@ -69,6 +69,11 @@
This function does not call the simulator, it returns the location
received in the last tick.
# --------------------------------------
- def_name: get_transform
return: carla.Transform
doc: >
Returns the current transform of the actor.
# --------------------------------------
- def_name: get_velocity
return: carla.Vector3D
doc: >

View File

@ -356,12 +356,12 @@
- def_name: __eq__
params:
- param_name: other
type: carla.Geolocation
type: carla.GeoLocation
# --------------------------------------
- def_name: __ne__
params:
- param_name: other
type: carla.Geolocation
type: carla.GeoLocation
# --------------------------------------
- def_name: __str__
params: