Skip to content

Commit

Permalink
Spelling and grammar fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
scop authored and ronf committed Jun 11, 2023
1 parent 3760d38 commit b0295a3
Show file tree
Hide file tree
Showing 18 changed files with 68 additions and 68 deletions.
8 changes: 4 additions & 4 deletions asyncssh/channel.py
Original file line number Diff line number Diff line change
Expand Up @@ -1007,7 +1007,7 @@ def resume_reading(self) -> None:
This method can be called to resume delivery of incoming data
which was suspended by a call to :meth:`pause_reading`. As soon
as this method is called, any buffered data will be delivered
immediately. A pending end-of-file notication may also be
immediately. A pending end-of-file notification may also be
delivered if one was queued while reading was paused.
"""
Expand Down Expand Up @@ -1042,7 +1042,7 @@ def get_command(self) -> Optional[str]:
This method returns the command the client requested to
execute when the session was opened, if any. If the client
did not request that a command be executed, this method
will return `None`. On the server, alls to this method
will return `None`. On the server, calls to this method
should only be made after :meth:`session_started
<SSHServerSession.session_started>` has been called on the
:class:`SSHServerSession`. When using the stream-based API,
Expand Down Expand Up @@ -1829,7 +1829,7 @@ def get_x11_display(self) -> Optional[str]:
forwarding, this method returns `None`.
:returns: A `str` containing the X11 display or `None` if
X11 fowarding was not requested
X11 forwarding was not requested
"""

Expand All @@ -1845,7 +1845,7 @@ def get_agent_path(self) -> Optional[str]:
`None`.
:returns: A `str` containing the ssh-agent socket path or
`None` if agent fowarding was not requested
`None` if agent forwarding was not requested
"""

Expand Down
2 changes: 1 addition & 1 deletion asyncssh/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ def auth_completed(self) -> None:
"""Authentication was completed successfully
This method is called when authentication has completed
succesfully. Applications may use this method to create
successfully. Applications may use this method to create
whatever client sessions and direct TCP/IP or UNIX domain
connections are needed and/or set up listeners for incoming
TCP/IP or UNIX domain connections coming from the server.
Expand Down
28 changes: 14 additions & 14 deletions asyncssh/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -664,7 +664,7 @@ class SSHAcceptor:
This class in a wrapper around an :class:`asyncio.Server` listener
which provides the ability to update the the set of SSH client or
server connection options associated wtih that listener. This is
server connection options associated with that listener. This is
accomplished by calling the :meth:`update` method, which takes the
same keyword arguments as the :class:`SSHClientConnectionOptions`
and :class:`SSHServerConnectionOptions` classes.
Expand Down Expand Up @@ -2545,7 +2545,7 @@ def abort(self) -> None:
"""Forcibly close the SSH connection
This method closes the SSH connection immediately, without
waiting for pending operations to complete and wihtout sending
waiting for pending operations to complete and without sending
an explicit SSH disconnect message. Buffered data waiting to be
sent will be lost and no more data will be received. When the
the connection is closed, :meth:`connection_lost()
Expand Down Expand Up @@ -6728,7 +6728,7 @@ class SSHClientConnectionOptions(SSHConnectionOptions):
:param password_auth: (optional)
Whether or not to allow password authentication. By default,
password authentication is enabled if a password is specified
or if callbacks to provide a password are made availble.
or if callbacks to provide a password are made available.
:param gss_host: (optional)
The principal name to use for the host in GSS key exchange and
authentication. If not specified, this value will be the same
Expand Down Expand Up @@ -6918,7 +6918,7 @@ class SSHClientConnectionOptions(SSHConnectionOptions):
:param config: (optional)
Paths to OpenSSH client configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options.
.. note:: Specifying configuration files when creating an
Expand Down Expand Up @@ -7377,7 +7377,7 @@ class SSHServerConnectionOptions(SSHConnectionOptions):
client connected from.
:param authorized_client_keys: (optional)
A list of authorized user and CA public keys which should be
trusted for certifcate-based client public key authentication.
trusted for certificate-based client public key authentication.
:param x509_trusted_certs: (optional)
A list of certificates which should be trusted for X.509 client
certificate authentication. If this argument is explicitly set
Expand Down Expand Up @@ -7567,7 +7567,7 @@ class SSHServerConnectionOptions(SSHConnectionOptions):
:param config: (optional)
Paths to OpenSSH server configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options.
.. note:: Specifying configuration files when creating an
Expand Down Expand Up @@ -7855,7 +7855,7 @@ async def run_client(sock: socket.socket, config: DefTuple[ConfigPaths] = (),
:param config: (optional)
Paths to OpenSSH client configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options. If no paths are specified and
no config paths were set when constructing the `options`
argument (if any), an attempt will be made to load the
Expand Down Expand Up @@ -7909,7 +7909,7 @@ async def run_server(sock: socket.socket, config: DefTuple[ConfigPaths] = (),
:param config: (optional)
Paths to OpenSSH server configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options. By default, no OpenSSH
configuration files will be loaded. See
:ref:`SupportedServerConfigOptions` for details on what
Expand Down Expand Up @@ -8015,7 +8015,7 @@ async def connect(host = '', port: DefTuple[int] = (), *,
:param config: (optional)
Paths to OpenSSH client configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options. If no paths are specified and
no config paths were set when constructing the `options`
argument (if any), an attempt will be made to load the
Expand Down Expand Up @@ -8121,7 +8121,7 @@ async def connect_reverse(
:param config: (optional)
Paths to OpenSSH server configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options. By default, no OpenSSH
configuration files will be loaded. See
:ref:`SupportedServerConfigOptions` for details on what
Expand Down Expand Up @@ -8238,7 +8238,7 @@ async def listen(host = '', port: DefTuple[int] = (), *,
:param config: (optional)
Paths to OpenSSH server configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options. By default, no OpenSSH
configuration files will be loaded. See
:ref:`SupportedServerConfigOptions` for details on what
Expand Down Expand Up @@ -8371,7 +8371,7 @@ async def listen_reverse(host = '', port: DefTuple[int] = (), *,
:param config: (optional)
Paths to OpenSSH client configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options. If no paths are specified and
no config paths were set when constructing the `options`
argument (if any), an attempt will be made to load the
Expand Down Expand Up @@ -8549,7 +8549,7 @@ async def get_server_host_key(
:param config: (optional)
Paths to OpenSSH client configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options. If no paths are specified and
no config paths were set when constructing the `options`
argument (if any), an attempt will be made to load the
Expand Down Expand Up @@ -8691,7 +8691,7 @@ async def get_server_auth_methods(
:param config: (optional)
Paths to OpenSSH client configuration files to load. This
configuration will be used as a fallback to override the
defaults for settings which are not explcitly specified using
defaults for settings which are not explicitly specified using
AsyncSSH's configuration options. If no paths are specified and
no config paths were set when constructing the `options`
argument (if any), an attempt will be made to load the
Expand Down
2 changes: 1 addition & 1 deletion asyncssh/editor.py
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ class SSHLineEditorChannel:
this class is wrapped around the channel, providing the caller with
the ability to enable and disable input line editing and echoing.
.. note:: Line editing is only available when a psuedo-terminal
.. note:: Line editing is only available when a pseudo-terminal
is requested on the server channel and the character
encoding on the channel is not set to `None`.
Expand Down
6 changes: 3 additions & 3 deletions asyncssh/encryption.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def new(cls, cipher_name: str, key: bytes, iv: bytes, mac_alg: bytes = b'',

@classmethod
def get_mac_params(cls, mac_alg: bytes) -> Tuple[int, int, bool]:
"""Get paramaters of the MAC algorithm used with this encryption"""
"""Get parameters of the MAC algorithm used with this encryption"""

return get_mac_params(mac_alg)

Expand Down Expand Up @@ -163,7 +163,7 @@ def new(cls, cipher_name: str, key: bytes, iv: bytes, mac_alg: bytes = b'',

@classmethod
def get_mac_params(cls, mac_alg: bytes) -> Tuple[int, int, bool]:
"""Get paramaters of the MAC algorithm used with this encryption"""
"""Get parameters of the MAC algorithm used with this encryption"""

return 0, 16, True

Expand Down Expand Up @@ -202,7 +202,7 @@ def new(cls, cipher_name: str, key: bytes, iv: bytes, mac_alg: bytes = b'',

@classmethod
def get_mac_params(cls, mac_alg: bytes) -> Tuple[int, int, bool]:
"""Get paramaters of the MAC algorithm used with this encryption"""
"""Get parameters of the MAC algorithm used with this encryption"""

return 0, 16, True

Expand Down
2 changes: 1 addition & 1 deletion asyncssh/pkcs11.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def sign(self, data: bytes) -> bytes:


class SSHPKCS11Session:
"""Work around PKCS#11 sesssions not supporting simultaneous opens"""
"""Work around PKCS#11 sessions not supporting simultaneous opens"""

_sessions: _SessionMap = {}

Expand Down
10 changes: 5 additions & 5 deletions asyncssh/public_key.py
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,7 @@ def generate_user_certificate(
comment: DefTuple[_Comment] = ()) -> 'SSHOpenSSHCertificate':
"""Generate a new SSH user certificate
This method returns an SSH user certifcate with the requested
This method returns an SSH user certificate with the requested
attributes signed by this private key.
:param user_key:
Expand Down Expand Up @@ -769,7 +769,7 @@ def generate_host_certificate(self, host_key: 'SSHKey', key_id: str,
'SSHOpenSSHCertificate':
"""Generate a new SSH host certificate
This method returns an SSH host certifcate with the requested
This method returns an SSH host certificate with the requested
attributes signed by this private key.
:param host_key:
Expand Down Expand Up @@ -830,7 +830,7 @@ def generate_x509_user_certificate(
comment: DefTuple[_Comment] = ()) -> 'SSHX509Certificate':
"""Generate a new X.509 user certificate
This method returns an X.509 user certifcate with the requested
This method returns an X.509 user certificate with the requested
attributes signed by this private key.
:param user_key:
Expand Down Expand Up @@ -901,7 +901,7 @@ def generate_x509_host_certificate(
comment: DefTuple[_Comment] = ()) -> 'SSHX509Certificate':
"""Generate a new X.509 host certificate
This method returns a X.509 host certifcate with the requested
This method returns an X.509 host certificate with the requested
attributes signed by this private key.
:param host_key:
Expand Down Expand Up @@ -972,7 +972,7 @@ def generate_x509_ca_certificate(self, ca_key: 'SSHKey', subject: str,
'SSHX509Certificate':
"""Generate a new X.509 CA certificate
This method returns a X.509 CA certifcate with the requested
This method returns an X.509 CA certificate with the requested
attributes signed by this private key.
:param ca_key:
Expand Down
10 changes: 5 additions & 5 deletions asyncssh/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ def auth_completed(self) -> None:
"""Authentication was completed successfully
This method is called when authentication has completed
succesfully. Applications may use this method to perform
successfully. Applications may use this method to perform
processing based on the authenticated username or options in
the authorized keys list or certificate associated with the
user before any sessions are opened or forwarding requests
Expand Down Expand Up @@ -575,7 +575,7 @@ def kbdint_auth_supported(self) -> bool:
authentication is supported. Applications wishing to support
it must have this method return `True` and implement
:meth:`get_kbdint_challenge` and :meth:`validate_kbdint_response`
to generate the apporiate challenges and validate the responses
to generate the appropriate challenges and validate the responses
for the user being authenticated.
By default, this method returns `NotImplemented` tying
Expand Down Expand Up @@ -677,7 +677,7 @@ def session_requested(self) -> MaybeAwait[_NewSession]:
If blocking operations need to be performed before the session
can be created, a coroutine which returns an
:class:`SSHServerSession` object can be returned instead of
the session iself. This can be either returned directly or as
the session itself. This can be either returned directly or as
a part of a tuple with an :class:`SSHServerChannel` object.
To reject this request, this method should return `False`
Expand Down Expand Up @@ -742,7 +742,7 @@ def connection_requested(self, dest_host: str, dest_port: int,
If blocking operations need to be performed before the session
can be created, a coroutine which returns an
:class:`SSHTCPSession` object can be returned instead of
the session iself. This can be either returned directly or as
the session itself. This can be either returned directly or as
a part of a tuple with an :class:`SSHTCPChannel` object.
By default, all connection requests are rejected.
Expand Down Expand Up @@ -857,7 +857,7 @@ def unix_connection_requested(self, dest_path: str) -> _NewUNIXSession:
If blocking operations need to be performed before the session
can be created, a coroutine which returns an
:class:`SSHUNIXSession` object can be returned instead of
the session iself. This can be either returned directly or as
the session itself. This can be either returned directly or as
a part of a tuple with an :class:`SSHUNIXChannel` object.
By default, all connection requests are rejected.
Expand Down
2 changes: 1 addition & 1 deletion asyncssh/session.py
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ def connection_made(self, chan: 'SSHServerChannel[AnyStr]') -> None:
def pty_requested(self, term_type: str,
term_size: Tuple[int, int, int, int],
term_modes: Mapping[int, int]) -> bool:
"""A psuedo-terminal has been requested
"""A pseudo-terminal has been requested
This method is called when the client sends a request to allocate
a pseudo-terminal with the requested terminal type, size, and
Expand Down
Loading

0 comments on commit b0295a3

Please sign in to comment.