Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Christian-B committed Oct 18, 2023
1 parent 260c89a commit a9e677f
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions spinn_machine/version/abstract_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit a9e677f

Please sign in to comment.