Skip to content

docs: Fix a few typos #1136

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/about/migrating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ Observing attribute changes
The DroneKit-Python 1.x observer function ``vehicle.add_attribute_observer`` has been replaced by
:py:func:`Vehicle.add_attribute_listener() <dronekit.Vehicle.add_attribute_listener>` or
:py:func:`Vehicle.on_attribute() <dronekit.Vehicle.on_attribute>` in DKYP2.x, and ``Vehicle.remove_attribute_observer``
has been repaced by :py:func:`remove_attribute_listener() <dronekit.Vehicle.remove_attribute_listener>`.
has been replaced by :py:func:`remove_attribute_listener() <dronekit.Vehicle.remove_attribute_listener>`.

The main difference is that the callback function now takes three arguments (the vehicle object, attribute name, attribute value)
rather than just the attribute name. This allows you to more easily write callbacks that support attribute-specific and
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/vehicle_state_and_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ The example below shows how you can declare an attribute callback using the
.. note::

The fragment above stores the result of the previous callback and only prints the output when there is a
signficant change in :py:attr:`Vehicle.rangefinder <dronekit.Vehicle.rangefinder>`. You might want to
significant change in :py:attr:`Vehicle.rangefinder <dronekit.Vehicle.rangefinder>`. You might want to
perform caching like this to ignore updates that are not significant to your code.

The examples above show how you can monitor a single attribute. You can pass the special name ('``*``') to specify a
Expand Down
2 changes: 1 addition & 1 deletion dronekit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2851,7 +2851,7 @@ def thr_min_callback(self, attr_name, value):

def remove_attribute_listener(self, attr_name, *args, **kwargs):
"""
Remove a paremeter listener that was previously added using :py:func:`add_attribute_listener`.
Remove a parameter listener that was previously added using :py:func:`add_attribute_listener`.

For example to remove the ``thr_min_callback()`` callback function:

Expand Down