Skip to content

Commit

Permalink
Address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
phschaad committed Dec 12, 2024
1 parent 34a3247 commit fad3424
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion dace/frontend/python/interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def program(f: F,
not depend on internal variables are constant.
This will hardcode their return values into the
resulting program.
:param use_explicit_cfl: If True, makes use of explicit control flow constructs.
:param use_explicit_cf: If True, makes use of explicit control flow constructs.
:note: If arguments are defined with type hints, the program can be compiled
ahead-of-time with ``.compile()``.
"""
Expand Down
20 changes: 10 additions & 10 deletions dace/sdfg/state.py
Original file line number Diff line number Diff line change
Expand Up @@ -2585,14 +2585,14 @@ class AbstractControlFlowRegion(OrderedDiGraph[ControlFlowBlock, 'dace.sdfg.Inte
ControlFlowBlock, abc.ABC):
"""
Abstract superclass to represent all kinds of control flow regions in an SDFG.
This is consequently one of the three main classes of control flow graph nodes, which include `ControlFlowBlock`s,
`SDFGState`s, and nested `AbstractControlFlowRegion`s. An `AbstractControlFlowRegion` can further be either a region
that directly contains a control flow graph (`ControlFlowRegion`s and subclasses thereof), or something that acts
like and has the same utilities as a control flow region, including the same API, but is itself not directly a
single graph. An example of this is the `ConditionalBlock`, which acts as a single control flow region to the
outside, but contains multiple actual graphs (one per branch). As such, there are very few but important differences
between the subclasses of `AbstractControlFlowRegion`s, such as how traversals are performed, how many start blocks
there are, etc.
This is consequently one of the three main classes of control flow graph nodes, which include ``ControlFlowBlock``s,
``SDFGState``s, and nested ``AbstractControlFlowRegion``s. An ``AbstractControlFlowRegion`` can further be either a
region that directly contains a control flow graph (``ControlFlowRegion``s and subclasses thereof), or something
that acts like and has the same utilities as a control flow region, including the same API, but is itself not
directly a single graph. An example of this is the ``ConditionalBlock``, which acts as a single control flow region
to the outside, but contains multiple actual graphs (one per branch). As such, there are very few but important
differences between the subclasses of ``AbstractControlFlowRegion``s, such as how traversals are performed, how many
start blocks there are, etc.
"""

def __init__(self, label: str = '', sdfg: Optional['SDFG'] = None,
Expand Down Expand Up @@ -2753,7 +2753,7 @@ def inline(self, lower_returns: bool = False) -> Tuple[bool, Any]:

return False, None

def new_symbols(self, symbols: dict) -> Dict[str, dtypes.typeclass]:
def new_symbols(self, symbols: Dict[str, dtypes.typeclass]) -> Dict[str, dtypes.typeclass]:
"""
Returns a mapping between the symbol defined by this control flow region and its type, if it exists.
"""
Expand Down Expand Up @@ -3099,7 +3099,7 @@ def start_block(self, block_id):
@make_properties
class ControlFlowRegion(AbstractControlFlowRegion):
"""
A `ControlFlowRegion` represents a control flow graph node that itself contains a control flow graph.
A ``ControlFlowRegion`` represents a control flow graph node that itself contains a control flow graph.
This can be an arbitrary control flow graph, but may also be a specific type of control flow region with additional
semantics, such as a loop or a function call.
"""
Expand Down

0 comments on commit fad3424

Please sign in to comment.