From a9e677f3a9950fbd0da7e8fa1d10339e4bf9f448 Mon Sep 17 00:00:00 2001 From: "Christian Y. Brenninkmeijer" Date: Wed, 18 Oct 2023 14:24:55 +0100 Subject: [PATCH] doc fixes --- spinn_machine/version/abstract_version.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/spinn_machine/version/abstract_version.py b/spinn_machine/version/abstract_version.py index e3b7a59d..f95e6618 100644 --- a/spinn_machine/version/abstract_version.py +++ b/spinn_machine/version/abstract_version.py @@ -316,17 +316,18 @@ def minimum_cores_expected(self) -> int: @abstractmethod def illegal_ethernet_message(self, x: int, y: int) -> Optional[str]: """ - Checks if x and y could be for an ethernet + Checks if x and y could be for an Ethernet This method will return an explanation if the values for x and y are known be illegal for an ethernet chip. - Due to the limited inforamtion available this method will generate - False negatives. Ie x, y that for this machine which can - not be ethernets generating no explanation. + Due to the limited information available this method will generate + False negatives. + So this method returning None does not imply that x, y is an + Ethernet location :param int x: :param int y: - :return: An explanation that the x and y can never be an ethernet + :return: An explanation that the x and y can never be an Ethernet """ raise NotImplementedError