Skip to content

Commit

Permalink
Spelling fixes for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
igo95862 committed Jan 30, 2021
1 parent 8284059 commit bdeb404
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 20 deletions.
12 changes: 6 additions & 6 deletions docs/asyncio_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Classes
:async:

Pings the remote object using dbus.
Usefull to test if remote object is alive.
Useful to test if remote object is alive.

.. py:method:: dbus_machine_id()
:async:
Expand Down Expand Up @@ -90,7 +90,7 @@ Classes
.. py:method:: start_serving(bus, object_path)
:async:

Object will apear and become callable on dbus.
Object will appear and become callable on dbus.

:param str object_path:
Object path that it will be available at.
Expand Down Expand Up @@ -151,7 +151,7 @@ Decorators
will be nameless

:param str method_name: Force specific dbus method name
instead of being based on Python funciton name.
instead of being based on Python function name.

Example::

Expand Down Expand Up @@ -185,7 +185,7 @@ Decorators
.. warning:: Properties are supposed
to be lightweight to get or set.
Make sure property getter or setter
does not preform heavy IO or computation
does not perform heavy IO or computation
as that will block other methods or properties.

:param str property_signature: Property dbus signature.
Expand All @@ -197,8 +197,8 @@ Decorators

See :ref:`dbus-flags` .

:param str property_name: Force specifc property name
instead of construcing it based on Python function name.
:param str property_name: Force specific property name
instead of constructing it based on Python function name.

Properties have following methods:

Expand Down
2 changes: 1 addition & 1 deletion docs/asyncio_quick.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ Example: ::

``MultipleInterfaces`` class will have both ``test_method`` and ``example_method``
that will be wired to correct interface names. (``org.example.myinterface``
and ``org.example.test`` respectivly)
and ``org.example.test`` respectively)
2 changes: 1 addition & 1 deletion docs/common_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Example, :py:obj:`DbusDeprecatedFlag` plus :py:obj:`DbusHiddenFlag`: ``DbusDepre
.. py:data:: DbusDeprecatedFlag
:type: int

Mark this method or propety as deprecated in introspection data.
Mark this method or property as deprecated in introspection data.

.. py:data:: DbusHiddenFlag
:type: int
Expand Down
4 changes: 2 additions & 2 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ There are 3 files:


async def startup() -> None:
"""Preform async startup actions"""
"""Perform async startup actions"""
# Acquire a known name on the bus
# Client will use that name to connect to this server
await request_default_bus_name_async('org.example.test')
Expand All @@ -95,7 +95,7 @@ There are 3 files:


async def print_clock() -> None:
# Use async for loop to print clock signals we recieve
# Use async for loop to print clock signals we receive
async for x in example_object.clock:
print('Got clock: ', x)

Expand Down
4 changes: 2 additions & 2 deletions docs/exceptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ These exceptions are bound to specific dbus error names. For example,
error name.

This means if the remote object sends an error message with this error name
the Python will recieve this exception.
the Python will receive this exception.

When raised in a method callback an error message will be sent
back to caller.
Expand Down Expand Up @@ -283,7 +283,7 @@ Error name exception list

.. py:exception:: DbusInvalidFileContentError
Invlaid file content.
Invalid file content.

.. py:attribute:: dbus_error_name
:type: str
Expand Down
8 changes: 4 additions & 4 deletions docs/general.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Dbus types conversion

`Dbus types reference <https://dbus.freedesktop.org/doc/dbus-specification.html#type-system>`_

.. note:: Python integers are unlimited size but dbus intergers are not.
.. note:: Python integers are unlimited size but dbus integers are not.
All integer types raise :py:exc:`OverflowError`
if you try to pass number outside the type size.

Expand Down Expand Up @@ -73,7 +73,7 @@ Dbus types conversion
| | | | I.E. ``a{si}`` is the dict with string keys and integer values. |
| | | | ``{si}`` is NOT a valid signature. |
+-------------+----------+-----------------+--------------------------------------------------------------------+
| Variant | v | :py:obj:`tuple` | Unknown type that can be any signle type. |
| Variant | v | :py:obj:`tuple` | Unknown type that can be any single type. |
| | | | In Python represented by a tuple of |
| | | | a signature string and a single type. |
| | | | |
Expand All @@ -93,7 +93,7 @@ Asyncio is a part of python standard library that allows non-blocking io.

`Asyncio documentation <https://docs.python.org/3/library/asyncio.html>`_

Generally blocking IO should only be used for simple scripts and programms that interact
Generally blocking IO should only be used for simple scripts and programs that interact
with existing dbus objects.

Blocking:
Expand All @@ -110,7 +110,7 @@ Asyncio:
^^^^^^^^^^^^^^^^^^^^^^^^
* Calls need to be ``await`` ed.
* Multiple requests at the same time.
* Serve object on dbus for other programms.
* Serve object on dbus for other programs.
* Dbus Signals.

:doc:`/asyncio_api`
Expand Down
4 changes: 2 additions & 2 deletions docs/proxies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ This is the dbus daemon interface. Used for querying dbus state.
Starts a specified service.

Flags parameter is not used currently and should be
omited or set to 0.
omitted or set to 0.

:param str service_name: Service name to start.
:param int flags: Not used. Omit or pass 0.
Expand Down Expand Up @@ -138,7 +138,7 @@ This is the dbus daemon interface. Used for querying dbus state.

* The name that acquired or lost
* Old owner (by unique bus name) or empty string if no one owned it
* New owner (by unique bus name) or emptry string if no one owns it now
* New owner (by unique bus name) or empty string if no one owns it now


Freedesktop Notifications
Expand Down
2 changes: 1 addition & 1 deletion docs/sync_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Classes
Pings the remote object using dbus.

Usefull to test if remote object is alive.
Useful to test if remote object is alive.

.. py:method:: dbus_machine_id()
Expand Down
2 changes: 1 addition & 1 deletion docs/sync_quick.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,4 @@ Example::

``MultipleInterfaces`` class will have both ``test_method`` and ``example_method``
that will be wired to correct interface names. (``org.example.myinterface``
and ``org.example.test`` respectivly)
and ``org.example.test`` respectively)

0 comments on commit bdeb404

Please sign in to comment.