Skip to content

Commit c809774

Browse files
authored
Fix typos in the manual (#599)
1 parent 251fee1 commit c809774

File tree

9 files changed

+10
-10
lines changed

9 files changed

+10
-10
lines changed

docs/client.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ Here is the ``asyncio`` version::
288288
Note that this function is not a coroutine, since it does not wait for the
289289
background function to end. The background function must be a coroutine.
290290

291-
The ``sleep()`` method is a second convenince function that is provided for
291+
The ``sleep()`` method is a second convenience function that is provided for
292292
the benefit of applications working with background tasks of their own::
293293

294294
sio.sleep(2)

docs/server.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -683,7 +683,7 @@ The Sanic application is then executed in the usual manner::
683683
app.run()
684684

685685
It has been reported that the CORS support provided by the Sanic extension
686-
`sanic-cors <https://github.com/ashleysommer/sanic-cors>`_ is incomaptible with
686+
`sanic-cors <https://github.com/ashleysommer/sanic-cors>`_ is incompatible with
687687
this package's own support for this protocol. To disable CORS support in this
688688
package and let Sanic take full control, initialize the server as follows::
689689

socketio/asyncio_aiopika_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class AsyncAioPikaManager(AsyncPubSubManager): # pragma: no cover
3030
notifications. Must be the same in all the servers.
3131
With this manager, the channel name is the exchange name
3232
in rabbitmq
33-
:param write_only: If set ot ``True``, only initialize to emit events. The
33+
:param write_only: If set to ``True``, only initialize to emit events. The
3434
default of ``False`` initializes the class for emitting
3535
and receiving.
3636
"""

socketio/asyncio_namespace.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ async def trigger_event(self, event, *args):
2424
2525
In the most common usage, this method is not overloaded by subclasses,
2626
as it performs the routing of events to methods. However, this
27-
method can be overriden if special dispatching rules are needed, or if
27+
method can be overridden if special dispatching rules are needed, or if
2828
having a single method that catches all events is desired.
2929
3030
Note: this method is a coroutine.
@@ -149,7 +149,7 @@ async def trigger_event(self, event, *args):
149149
150150
In the most common usage, this method is not overloaded by subclasses,
151151
as it performs the routing of events to methods. However, this
152-
method can be overriden if special dispatching rules are needed, or if
152+
method can be overridden if special dispatching rules are needed, or if
153153
having a single method that catches all events is desired.
154154
155155
Note: this method is a coroutine.

socketio/asyncio_redis_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class AsyncRedisManager(AsyncPubSubManager): # pragma: no cover
4444
SSL connection, use ``rediss://``.
4545
:param channel: The channel name on which the server sends and receives
4646
notifications. Must be the same in all the servers.
47-
:param write_only: If set ot ``True``, only initialize to emit events. The
47+
:param write_only: If set to ``True``, only initialize to emit events. The
4848
default of ``False`` initializes the class for emitting
4949
and receiving.
5050
"""

socketio/kafka_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class KafkaManager(PubSubManager): # pragma: no cover
2828
:param channel: The channel name (topic) on which the server sends and
2929
receives notifications. Must be the same in all the
3030
servers.
31-
:param write_only: If set ot ``True``, only initialize to emit events. The
31+
:param write_only: If set to ``True``, only initialize to emit events. The
3232
default of ``False`` initializes the class for emitting
3333
and receiving.
3434
"""

socketio/kombu_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class KombuManager(PubSubManager): # pragma: no cover
3131
connection URLs.
3232
:param channel: The channel name on which the server sends and receives
3333
notifications. Must be the same in all the servers.
34-
:param write_only: If set ot ``True``, only initialize to emit events. The
34+
:param write_only: If set to ``True``, only initialize to emit events. The
3535
default of ``False`` initializes the class for emitting
3636
and receiving.
3737
:param connection_options: additional keyword arguments to be passed to

socketio/namespace.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ def trigger_event(self, event, *args):
1010
1111
In the most common usage, this method is not overloaded by subclasses,
1212
as it performs the routing of events to methods. However, this
13-
method can be overriden if special dispatching rules are needed, or if
13+
method can be overridden if special dispatching rules are needed, or if
1414
having a single method that catches all events is desired.
1515
"""
1616
handler_name = 'on_' + event

socketio/redis_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class RedisManager(PubSubManager): # pragma: no cover
3030
store running on the same host, use ``redis://``.
3131
:param channel: The channel name on which the server sends and receives
3232
notifications. Must be the same in all the servers.
33-
:param write_only: If set ot ``True``, only initialize to emit events. The
33+
:param write_only: If set to ``True``, only initialize to emit events. The
3434
default of ``False`` initializes the class for emitting
3535
and receiving.
3636
:param redis_options: additional keyword arguments to be passed to

0 commit comments

Comments
 (0)