Skip to content

Commit

Permalink
Fix up documentation.
Browse files Browse the repository at this point in the history
Suggestions courtesy @mundya
  • Loading branch information
mossblaser committed Jan 12, 2016
1 parent 43b74b1 commit ea00973
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions docs/source/routing_table_tools_doctest.rst
Expand Up @@ -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.
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion rig/place_and_route/wrapper.py
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion rig/routing_table/minimise.py
Expand Up @@ -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
------
Expand Down

1 comment on commit ea00973

@mundya
Copy link
Member

@mundya mundya commented on ea00973 Jan 12, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Please sign in to comment.