Skip to content

Commit

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

.. py:classmethod:: new_connect(bus, service_name, object_path)
Create new binded object and bypass ``__init__``.
Create new bounded object and bypass ``__init__``.

:param str service_name:
Remote object dbus connection name.
Expand Down Expand Up @@ -116,7 +116,7 @@ Decorators
Defaults to "" meaning method returns empty reply on success.
Required if you intend to serve the object.

:param int flags: modifies behaivor.
:param int flags: modifies behavior.
No effect on remote connections.
Defaults to 0 meaning no special behavior.

Expand Down Expand Up @@ -191,7 +191,7 @@ Decorators
:param str property_signature: Property dbus signature.
Has to be a single type or container.

:param int flags: modifies behaivor.
:param int flags: modifies behavior.
No effect on remote connections.
Defaults to 0 meaning no special behavior.

Expand Down Expand Up @@ -270,7 +270,7 @@ Decorators

Defaults to result arguments being nameless.

:param int flags: modifies behaivor.
:param int flags: modifies behavior.
No effect on remote connections.
Defaults to 0 meaning no special behavior.

Expand Down
6 changes: 3 additions & 3 deletions docs/asyncio_quick.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Example::
class ExampleInterface(DbusInterfaceCommonAsync,
interface_name='org.example.myinterface'
):
# Method that takes an integer and mutltiplies it by 2
# Method that takes an integer and multiplies it by 2
@dbus_method_async('i', 'i')
async def double_int(self, an_int: int) -> None:
return an_int * 2
Expand Down Expand Up @@ -144,7 +144,7 @@ Example::
async def upper(self, str_to_up: str) -> str:
return str_to_up.upper()

Methods behaive exact same way as Python methods would: ::
Methods behave exact same way as Python methods would: ::

print(await example_object.upper('test')) # prints TEST

Expand Down Expand Up @@ -192,7 +192,7 @@ Example: ::

Properties are supposed to be lightweight. Make sure you don't block event loop with getter or setter.

Async properties do not behaive the same way as :py:func:`property` decorator does.
Async properties do not behave the same way as :py:func:`property` decorator does.

To get the value of the property you can either directly ``await`` on property
or use :py:meth:`get_async` method. (also need to be awaited)
Expand Down
6 changes: 3 additions & 3 deletions docs/common_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Helper functions

.. py:function:: encode_object_path(prefix, external)
Encode that abitrary string as a valid object path prefixed
Encode that arbitrary string as a valid object path prefixed
with prefix.

:param str prefix: Prefix path. Must be a valid object path.
Expand Down Expand Up @@ -139,11 +139,11 @@ Example, :py:obj:`DbusDeprecatedFlag` plus :py:obj:`DbusHiddenFlag`: ``DbusDepre
.. py:data:: DbusPropertyExplicitFlag
:type: int

This property is too heavy to calculate so its not included ig GetAll method
This property is too heavy to calculate so its not included in GetAll method
call.

.. py:data:: DbusSensitiveFlag
:type: int

Data in messages in sensitive and will be scrubed from memory after message
Data in messages in sensitive and will be scrubbed from memory after message
is red.
2 changes: 1 addition & 1 deletion docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ There are 3 files:

from example_interface import ExampleInterface

# Create a new binded object
# Create a new bounded object
example_object = ExampleInterface.new_connect('org.example.test', '/')


Expand Down
4 changes: 2 additions & 2 deletions docs/exceptions.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Excepctions
Exceptions
========================

Error name bound exceptions
Expand Down Expand Up @@ -140,7 +140,7 @@ Error name exception list

.. py:exception:: DbusAccessDeniedError
Caller does not have enough privelledges.
Caller does not have enough privileges.

.. py:attribute:: dbus_error_name
:type: str
Expand Down
4 changes: 2 additions & 2 deletions docs/general.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ with existing dbus objects.
Blocking:
^^^^^^^^^^^^^^^^^^^^^
* Blocking is easier to initiate (no event loop)
* Properties behaive exactly as Python properties do. (i.e. can asing with '=' operator)
* Properties behave exactly as Python properties do. (i.e. can assign with '=' operator)
* Only allows one request at a time.
* No dbus signals.
* Cannot serve objects, only interact with existing object on dbus.
Expand Down Expand Up @@ -125,7 +125,7 @@ Python uses snake_case.
When decorating a method name will be automatically translated from snake_case
to CamelCase. Example: ``close_notification`` -> ``CloseNotification``

However, all decorators have a parametre to force Dbus name to a specific value.
However, all decorators have a parameter to force Dbus name to a specific value.
See API documentation for a particular decorator.


Expand Down
6 changes: 3 additions & 3 deletions docs/proxies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ for more details.
:returns: List of capabilities
:rtype: List[str]

.. py:method:: get_server_infomation()
.. py:method:: get_server_information()
:async:

Returns notification server information.
Expand Down Expand Up @@ -235,7 +235,7 @@ for more details.
:param bool is_resident: When set the server will not automatically remove the notification when an action has been invoked.
:param Union[str,Path] sound_file_path: The path to a sound file to play when the notification pops up.
:param str sound_name: A themeable named sound to play. Similar to icon-name, only for sounds. An example would be "message-new-instant".
:param bool suppress_sound: Causes the server to suppress playing any sounds when this notificaiotn is displayed.
:param bool suppress_sound: Causes the server to suppress playing any sounds when this notification is displayed.
:param bool is_transient: When set the server will treat the notification as transient and by-pass the server's persistence capability.
:param Tuple[int,int] xy_pos: Specifies the X and Y location on the screen that the notification should point to.
:param int urgency: The urgency level. (what urgency levels there are?)
Expand All @@ -247,7 +247,7 @@ for more details.

First element of tuple is notification id.

Second elemt is the index of the action invoked. Matches the index of passed list of actions.
Second element is the index of the action invoked. Matches the index of passed list of actions.

.. py:attribute:: notification_closed
:type: Tuple[int, int]
Expand Down
4 changes: 2 additions & 2 deletions docs/sync_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Decorators
Defaults to "" meaning method takes no arguments.
Required if method takes any arguments.

:param int flags: modifies behaivor.
:param int flags: modifies behavior.
No effect on remote connections.
Defaults to 0 meaning no special behavior.

Expand Down Expand Up @@ -164,7 +164,7 @@ Decorators
Defaults to empty signature "".
Required only for writable properties.

:param int flags: modifies behaivor.
:param int flags: modifies behavior.
No effect on remote connections.
Defaults to 0 meaning no special behavior.

Expand Down
2 changes: 1 addition & 1 deletion docs/sync_quick.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Example::
def test_string(self) -> str:
raise NotImplementedError

The new property behaives very similar to Pythons :py:func:`property` decorator. ::
The new property behaves very similar to Pythons :py:func:`property` decorator. ::

# Initialize the object
d = ExampleInterface(
Expand Down

0 comments on commit 87160c0

Please sign in to comment.