Skip to content

Commit 60db830

Browse files
committed
Use more inclusive language
1 parent a213aed commit 60db830

File tree

4 files changed

+16
-12
lines changed

4 files changed

+16
-12
lines changed

.pylintrc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
# run arbitrary code.
66
extension-pkg-whitelist=
77

8-
# Add files or directories to the blacklist. They should be base names, not
8+
# Add files or directories to be ignored. They should be base names, not
99
# paths.
1010
ignore=CVS
1111

12-
# Add files or directories matching the regex patterns to the blacklist. The
12+
# Add files or directories matching the regex patterns to be ignored. The
1313
# regex matches against base names, not paths.
1414
ignore-patterns=
1515

.pylintrc-wip

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
# run arbitrary code.
66
extension-pkg-whitelist=
77

8-
# Add files or directories to the blacklist. They should be base names, not
8+
# Add files or directories to be ignored. They should be base names, not
99
# paths.
1010
ignore=CVS
1111

12-
# Add files or directories matching the regex patterns to the blacklist. The
12+
# Add files or directories matching the regex patterns to to be ignored. The
1313
# regex matches against base names, not paths.
1414
ignore-patterns=
1515

can/interfaces/ixxat/canlib.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ def __init__(self, channel, can_filters=None, **kwargs):
531531
constants.CAN_ACC_MASK_NONE,
532532
)
533533
for can_filter in can_filters:
534-
# Whitelist
534+
# Filters define what messages are accepted
535535
code = int(can_filter["can_id"])
536536
mask = int(can_filter["can_mask"])
537537
extended = can_filter.get("extended", False)

doc/interfaces/ixxat.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,17 @@ module, while the following parameters are optional and are interpreted by IXXAT
4343
* ``extended`` (default False) Allow usage of extended IDs
4444

4545

46+
Filtering
47+
---------
48+
49+
The CAN filters act as an allow list in IXXAT implementation, that is if you
50+
supply a non-empty filter list you must explicitly state EVERY frame you want
51+
to receive (including RTR field).
52+
The can_id/mask must be specified according to IXXAT behaviour, that is
53+
bit 0 of can_id/mask parameters represents the RTR field in CAN frame. See IXXAT
54+
VCI documentation, section "Message filters" for more info.
55+
56+
4657
Internals
4758
---------
4859

@@ -58,10 +69,3 @@ explicitly instantiated by the caller.
5869

5970
RX and TX FIFO sizes are configurable with ``rxFifoSize`` and ``txFifoSize``
6071
options, defaulting at 16 for both.
61-
62-
The CAN filters act as a "whitelist" in IXXAT implementation, that is if you
63-
supply a non-empty filter list you must explicitly state EVERY frame you want
64-
to receive (including RTR field).
65-
The can_id/mask must be specified according to IXXAT behaviour, that is
66-
bit 0 of can_id/mask parameters represents the RTR field in CAN frame. See IXXAT
67-
VCI documentation, section "Message filters" for more info.

0 commit comments

Comments
 (0)