Use more inclusive language

hardbyte · hardbyte · commit 60db830f3cf7 · 2020-07-09T22:54:03.000+12:00
diff --git a/.pylintrc b/.pylintrc
@@ -5,11 +5,11 @@
 # run arbitrary code.
 extension-pkg-whitelist=
 
-# Add files or directories to the blacklist. They should be base names, not
+# Add files or directories to be ignored. They should be base names, not
 # paths.
 ignore=CVS
 
-# Add files or directories matching the regex patterns to the blacklist. The
+# Add files or directories matching the regex patterns to be ignored. The
 # regex matches against base names, not paths.
 ignore-patterns=
 
diff --git a/.pylintrc-wip b/.pylintrc-wip
@@ -5,11 +5,11 @@
 # run arbitrary code.
 extension-pkg-whitelist=
 
-# Add files or directories to the blacklist. They should be base names, not
+# Add files or directories to be ignored. They should be base names, not
 # paths.
 ignore=CVS
 
-# Add files or directories matching the regex patterns to the blacklist. The
+# Add files or directories matching the regex patterns to to be ignored. The
 # regex matches against base names, not paths.
 ignore-patterns=
 
diff --git a/can/interfaces/ixxat/canlib.py b/can/interfaces/ixxat/canlib.py
@@ -531,7 +531,7 @@ def __init__(self, channel, can_filters=None, **kwargs):
                     constants.CAN_ACC_MASK_NONE,
                 )
             for can_filter in can_filters:
-                # Whitelist
+                # Filters define what messages are accepted
                 code = int(can_filter["can_id"])
                 mask = int(can_filter["can_mask"])
                 extended = can_filter.get("extended", False)
diff --git a/doc/interfaces/ixxat.rst b/doc/interfaces/ixxat.rst
@@ -43,6 +43,17 @@ module, while the following parameters are optional and are interpreted by IXXAT
 * ``extended`` (default False) Allow usage of extended IDs
 
 
+Filtering
+---------
+
+The CAN filters act as an allow list in IXXAT implementation, that is if you
+supply a non-empty filter list you must explicitly state EVERY frame you want
+to receive (including RTR field).
+The can_id/mask must be specified according to IXXAT behaviour, that is
+bit 0 of can_id/mask parameters represents the RTR field in CAN frame. See IXXAT
+VCI documentation, section "Message filters" for more info.
+
+
 Internals
 ---------
 
@@ -58,10 +69,3 @@ explicitly instantiated by the caller.
 
 RX and TX FIFO sizes are configurable with ``rxFifoSize`` and ``txFifoSize``
 options, defaulting at 16 for both.
-
-The CAN filters act as a "whitelist" in IXXAT implementation, that is if you
-supply a non-empty filter list you must explicitly state EVERY frame you want
-to receive (including RTR field).
-The can_id/mask must be specified according to IXXAT behaviour, that is
-bit 0 of can_id/mask parameters represents the RTR field in CAN frame. See IXXAT
-VCI documentation, section "Message filters" for more info.

Original file line number	Diff line number	Diff line change
`@@ -531,7 +531,7 @@ def __init__(self, channel, can_filters=None, **kwargs):`
`531`	`531`	`constants.CAN_ACC_MASK_NONE,`
`532`	`532`	`)`
`533`	`533`	`for can_filter in can_filters:`
`534`		`- # Whitelist`
	`534`	`+ # Filters define what messages are accepted`
`535`	`535`	`code = int(can_filter["can_id"])`
`536`	`536`	`mask = int(can_filter["can_mask"])`
`537`	`537`	`extended = can_filter.get("extended", False)`