Skip to content

Various spelling corrections in the generated docs #572

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

Merged
merged 1 commit into from
May 9, 2019
Merged
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 README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Features
- many different loggers and readers supporting playback: ASC (CANalyzer format), BLF (Binary Logging Format by Vector), CSV, SQLite and Canutils log
- efficient in-kernel or in-hardware filtering of messages on supported interfaces
- bus configuration reading from file or environment variables
- CLI tools for working with CAN busses (see the `docs <https://python-can.readthedocs.io/en/stable/scripts.html>`__)
- CLI tools for working with CAN buses (see the `docs <https://python-can.readthedocs.io/en/stable/scripts.html>`__)
- more


Expand Down
2 changes: 1 addition & 1 deletion can/interfaces/virtual.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ def _detect_available_configs():
.. note::

This method will run into problems if thousands of
autodetected busses are used at once.
autodetected buses are used at once.

"""
with channels_lock:
Expand Down
2 changes: 1 addition & 1 deletion can/io/csv.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class CSVReader(BaseIOHandler):
format as described there. Assumes that there is a header
and thus skips the first line.

Any line seperator is accepted.
Any line separator is accepted.
"""

def __init__(self, file):
Expand Down
2 changes: 1 addition & 1 deletion can/io/printer.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class Printer(BaseIOHandler, Listener):
"""
The Printer class is a subclass of :class:`~can.Listener` which simply prints
any messages it receives to the terminal (stdout). A message is tunred into a
any messages it receives to the terminal (stdout). A message is turned into a
string using :meth:`~can.Message.__str__`.

:attr bool write_to_file: `True` iff this instance prints to a file instead of
Expand Down
6 changes: 3 additions & 3 deletions can/io/sqlite.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

log = logging.getLogger('can.io.sqlite')

if sys.version_info.major < 3:
if sys.version_info.major < 3:
# legacy fallback for Python 2
memoryview = buffer

Expand Down Expand Up @@ -58,7 +58,7 @@ def __iter__(self):
for frame_data in self._cursor.execute("SELECT * FROM {}".format(self.table_name)):
yield SqliteReader._assemble_message(frame_data)

@staticmethod
@staticmethod
def _assemble_message(frame_data):
timestamp, can_id, is_extended, is_remote, is_error, dlc, data = frame_data
return Message(
Expand Down Expand Up @@ -103,7 +103,7 @@ class SqliteWriter(BaseIOHandler, BufferedReader):
:meth:`~can.SqliteWriter.stop()` may take a while.

:attr str table_name: the name of the database table used for storing the messages
:attr int num_frames: the number of frames actally writtem to the database, this
:attr int num_frames: the number of frames actually written to the database, this
excludes messages that are still buffered
:attr float last_write: the last time a message war actually written to the database,
as given by ``time.time()``
Expand Down
4 changes: 2 additions & 2 deletions can/notifier.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Notifier(object):
def __init__(self, bus, listeners, timeout=1.0, loop=None):
"""Manages the distribution of :class:`can.Message` instances to listeners.

Supports multiple busses and listeners.
Supports multiple buses and listeners.

.. Note::

Expand Down Expand Up @@ -127,7 +127,7 @@ def _on_error(self, exc):
listener.on_error(exc)

def add_listener(self, listener):
"""Add new Listener to the notification list.
"""Add new Listener to the notification list.
If it is already present, it will be called two times
each time a message arrives.

Expand Down
2 changes: 1 addition & 1 deletion doc/interfaces/ixxat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ module, while the following parameters are optional and are interpreted by IXXAT
Internals
---------

The IXXAT :class:`~can.BusABC` object is a farly straightforward interface
The IXXAT :class:`~can.BusABC` object is a fairly straightforward interface
to the IXXAT VCI library. It can open a specific device ID or use the
first one found.

Expand Down
2 changes: 1 addition & 1 deletion doc/interfaces/nican.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This interface adds support for CAN controllers by `National Instruments`_.

.. warning::

CAN filtering has not been tested throughly and may not work as expected.
CAN filtering has not been tested thoroughly and may not work as expected.


Bus
Expand Down
6 changes: 3 additions & 3 deletions test/back2back_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
# coding: utf-8

"""
This module tests two virtual busses attached to each other.
This module tests two virtual buses attached to each other.
"""

from __future__ import absolute_import, print_function

import sys
import unittest
from time import sleep
from multiprocessing.dummy import Pool as ThreadPool
from multiprocessing.dummy import Pool as ThreadPool

import pytest
import random
Expand Down Expand Up @@ -90,7 +90,7 @@ def test_timestamp(self):
recv_msg2 = self.bus1.recv(self.TIMEOUT)
delta_time = recv_msg2.timestamp - recv_msg1.timestamp
self.assertTrue(1.75 <= delta_time <= 2.25,
'Time difference should have been 2s +/- 250ms.'
'Time difference should have been 2s +/- 250ms.'
'But measured {}'.format(delta_time))

def test_standard_message(self):
Expand Down