From ea00973455e8e327828764bfb9c0392fe7b9a561 Mon Sep 17 00:00:00 2001 From: Jonathan Heathcote Date: Tue, 12 Jan 2016 16:24:55 +0000 Subject: [PATCH] Fix up documentation. Suggestions courtesy @mundya --- docs/source/routing_table_tools_doctest.rst | 10 +++++----- rig/place_and_route/wrapper.py | 2 +- rig/routing_table/minimise.py | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/routing_table_tools_doctest.rst b/docs/source/routing_table_tools_doctest.rst index e6be9bc..74e2a17 100644 --- a/docs/source/routing_table_tools_doctest.rst +++ b/docs/source/routing_table_tools_doctest.rst @@ -116,8 +116,8 @@ of 1024 entries. Certain applications may find that they exhaust this limited resource and may wish to attempt to shrink their routing tables by making better use of the SpiNNaker router's capabilities. For example, if a packet's key does not match any routing entries it will be "default routed" in the -direciton in which it was already travelling and thus no routing table entry is -requried. Additionally, by more fully exploiting the behaviour of the Ternary +direction in which it was already travelling and thus no routing table entry is +required. Additionally, by more fully exploiting the behaviour of the Ternary Content Addressable Memory (TCAM) used in SpiNNaker's multicast router it is often possible to compress (or minimise) a given routing table into a more compact, yet logically equivalent, form. @@ -152,9 +152,9 @@ The following minimisation algorithms are currently available: :py:func:`.minimise` prototype ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Routing table minimisation functions always named ``minimise()`` contained -within a Python module named after the algorithm. These :py:func:`.minimise` -functions have the signature defined below. +Routing table minimisation functions are always named ``minimise()`` and are +contained within a Python module named after the algorithm. These +:py:func:`.minimise` functions have the signature defined below. .. py:function:: minimise(routing_table, target_length=1024) diff --git a/rig/place_and_route/wrapper.py b/rig/place_and_route/wrapper.py index 37f1402..99975a6 100644 --- a/rig/place_and_route/wrapper.py +++ b/rig/place_and_route/wrapper.py @@ -100,7 +100,7 @@ def place_and_route_wrapper(vertices_resources, vertices_applications, **Optional.** Algorithm-specific arguments for the router. minimise_tables_methods : [:py:func:`rig.routing_table.minimise`, ...] **Optional.** An iterable of routing table minimisation algorithms to - use when routing tables out grow the space available. Each method is + use when routing tables outgrow the space available. Each method is tried in the order presented and the first to meet the required target length for a given chip is used. Consequently less computationally costly algorithms should be nearer the start of the list. The default diff --git a/rig/routing_table/minimise.py b/rig/routing_table/minimise.py index 40c1ad5..d705fd6 100644 --- a/rig/routing_table/minimise.py +++ b/rig/routing_table/minimise.py @@ -41,7 +41,7 @@ def minimise_tables(routing_tables, target_lengths, ------- {(x, y): [:py:class:`~rig.routing_table.RoutingTableEntry`, ...], ...} Minimised routing tables, guaranteed to be at least as small as the - table sizes specified by `target_lengths` + table sizes specified by `target_lengths`. Raises ------