Skip to content

Commit e1e6931

Browse files
committed
small doc fixes
1 parent 947363b commit e1e6931

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

can/bus.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# coding: utf-8
33

44
"""
5-
Contains the ABC bus implementation and it's documentation.
5+
Contains the ABC bus implementation and its documentation.
66
"""
77

88
from __future__ import print_function, absolute_import
@@ -62,8 +62,8 @@ class BusABC(object):
6262
def __init__(self, channel=None, can_filters=None, **config):
6363
"""Construct and open a CAN bus instance of the specified type.
6464
65-
Subclasses should call though this one with all parameters as
66-
it applies filters (for now).
65+
Subclasses should call though this method with all given parameters
66+
as it handles generic tasks like applying filters.
6767
6868
:param channel:
6969
The can interface identifier. Expected type is backend dependent.

can/interfaces/ics_neovi/neovi_bus.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
class ICSApiError(CanError):
3232
"""
33-
TODO add docs
33+
Indicates an error with the ICS API.
3434
"""
3535

3636
# A critical error which affects operation or accuracy.
@@ -42,10 +42,8 @@ class ICSApiError(CanError):
4242
# An error which probably does not need attention.
4343
ICS_SPY_ERR_INFORMATION = 0x40
4444

45-
def __init__(
46-
self, error_number, description_short, description_long,
47-
severity, restart_needed
48-
):
45+
def __init__(self, error_number, description_short, description_long,
46+
severity, restart_needed):
4947
super(ICSApiError, self).__init__(description_short)
5048
self.error_number = error_number
5149
self.description_short = description_short

0 commit comments

Comments
 (0)