diff --git a/spinn_utilities/helpful_functions.py b/spinn_utilities/helpful_functions.py index da8ebbe9..8a59515d 100644 --- a/spinn_utilities/helpful_functions.py +++ b/spinn_utilities/helpful_functions.py @@ -60,10 +60,12 @@ def lcm(*numbers) -> int: GIGO: If any of the values are anything except positive `int` values this function will either produce incorrect results or raise an exception. - :param numbers: The Positive integers to get the LCM for. + :param numbers: + The Positive integers to get the Lowest common multiple for. This can be zero, one or more int values or a singleton which is an iterator (possibly empty) of `int`\\s. - :return: the LCM, or 1 if `numbers` is empty or an empty iterator + :return: the Lowest common multiple, + or 1 if `numbers` is empty or an empty iterator :rtype: int :raises TypeError: If any value cannot be interpreted as an integer :raises ZeroDivisionError: May be raised if one of the values is zero diff --git a/spinn_utilities/ranged/abstract_dict.py b/spinn_utilities/ranged/abstract_dict.py index c401c757..cb227d2a 100644 --- a/spinn_utilities/ranged/abstract_dict.py +++ b/spinn_utilities/ranged/abstract_dict.py @@ -98,7 +98,7 @@ def ids(self) -> Sequence[int]: to create the view is maintained. .. note:: - If indexing into a view, you are picking the X'th ID. + If indexing into a view, you are picking the Nth ID. So if the IDs are `[2,3,4,5]` the `view[2]` will be the data for ID `4` and not `2` diff --git a/spinn_utilities/require_subclass.py b/spinn_utilities/require_subclass.py index d0ac3bf7..89f5e14f 100644 --- a/spinn_utilities/require_subclass.py +++ b/spinn_utilities/require_subclass.py @@ -49,7 +49,7 @@ class AbstractVirtual(object): # The use of __class__ to enable super() to work is from: # https://stackoverflow.com/a/43779009/301832 # The need to do this as a functional decorator is my own discovery; - # without it, some very weird interactions with metaclasses happen and I + # without it, some very weird interactions with meta classes happen and I # really don't want to debug that stuff. def decorate(target_class): diff --git a/spinn_utilities/safe_eval.py b/spinn_utilities/safe_eval.py index 48f74170..13c5f8f2 100644 --- a/spinn_utilities/safe_eval.py +++ b/spinn_utilities/safe_eval.py @@ -22,7 +22,7 @@ class SafeEval(object): >>> import math >>> def evil_func(x): - ... print("HAHA!") + ... print("Hello World!") ... return x/0.0 ... >>> eval_safely = SafeEval(math)