Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
add my suggestions before merging this PR with the other

Co-Authored-By: Jack Koenig <koenig@sifive.com>
  • Loading branch information
mwachs5 and jackkoenig committed Mar 12, 2020
1 parent 1b4169b commit b48b3ed
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/main/scala/diplomacy/Nodes.scala
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ import scala.util.matching._
*
* Specific applications of Diplomacy are expected to either extend these types
* or to specify concrete types for the type parameters. This allows for
* creating application-specific node, edge, parameter, and bundle types.
* creating and associating application-specific node, edge, parameter, and bundle types.
*
* Is an "edge" and a binding the same thing?
*
Expand All @@ -116,7 +116,7 @@ import scala.util.matching._
* - Upward refers to a flow of parameters in the outward direction.
* - Downward refers to a flow of parameters in the inward direction.
*
* A useful mnemonic for distinguishing between inward and outward is to imagine
* A useful mnemonic for distinguishing between upward and downward is to imagine
* the diplomatic graph as a literal network of rivers where upward refers to
* parameters that move in the upstream direction while downward refers to
* parameters that move in the downstream direction.
Expand Down Expand Up @@ -286,7 +286,7 @@ abstract class NodeImp[D, U, EO, EI, B <: Data]
* @tparam B Bundle type used when connecting the node
* A NodeImp where the inward and outward edges are of the same type.
*
* If your edges have the same direction, using this saves you some typing.
* If your edges have the same type in both directions, using this saves you some typing.
*/
abstract class SimpleNodeImp[D, U, E, B <: Data]
extends NodeImp[D, U, E, E, B]
Expand Down Expand Up @@ -429,7 +429,7 @@ trait NoHandle
case object NoHandleObject extends NoHandle

/**
* A Handle that can be on both sides of a bind operator.
* A Handle that can be used on either side of a bind operator.
*/
trait NodeHandle[DI, UI, EI, BI <: Data, DO, UO, EO, BO <: Data]
extends InwardNodeHandle[DI, UI, EI, BI] with OutwardNodeHandle[DO, UO, EO, BO]
Expand Down Expand Up @@ -1007,7 +1007,7 @@ abstract class CustomNode[D, U, EO, EI, B <: Data](imp: NodeImp[D, U, EO, EI, B]
extends MixedCustomNode(imp, imp)

/**
*
* A node that can connect multiple inward edges of one NodeImp to multiple outward edges of a different NodeImp
*/
class MixedJunctionNode[DI, UI, EI, BI <: Data, DO, UO, EO, BO <: Data](
inner: InwardNodeImp [DI, UI, EI, BI],
Expand Down

0 comments on commit b48b3ed

Please sign in to comment.