Skip to content
Snippets Groups Projects
Commit 34bb037a authored by Jammer, Tim's avatar Jammer, Tim
Browse files

fix documentation

parent 0fd7778a
Branches
No related tags found
1 merge request!5more work on infrastructure III
...@@ -119,7 +119,7 @@ class TemplateManager: ...@@ -119,7 +119,7 @@ class TemplateManager:
def register_instruction_block(self, block): def register_instruction_block(self, block):
""" """
Registers an instruction block with the template. Registers an instruction block with the template. inserting it at the end, before the mpi finalize
Parameters: Parameters:
- block: The instruction block to register. - block: The instruction block to register.
""" """
...@@ -160,7 +160,7 @@ class TemplateManager: ...@@ -160,7 +160,7 @@ class TemplateManager:
def get_block(self, block_name=None, idx=None): def get_block(self, block_name=None, idx=None):
""" """
Retrieves the given Instruction Block Either by name or by index Retrieves the given Instruction Block Either by name or by index
Raises IndexError if not the specified block is not found Raises IndexError if the specified block is not found
Raises IndexError if multiple Blocks with the given name are found Raises IndexError if multiple Blocks with the given name are found
Raises ValueError if Both a block name and index are given (or none is given) Raises ValueError if Both a block name and index are given (or none is given)
Args: Args:
...@@ -186,10 +186,11 @@ class TemplateManager: ...@@ -186,10 +186,11 @@ class TemplateManager:
return self._blocks[idx] return self._blocks[idx]
raise ValueError("Neither Both block name nor index is given") raise ValueError("Neither Both block name nor index is given")
def insert_block(self, new_block, block_name=None, idx=None): def insert_block(self, new_block, block_name=None, idx=None):
""" """
inserts the given Instruction Block AFTER the one specified Either by name or by index inserts the given Instruction Block AFTER the one specified Either by name or by index
Raises IndexError if not the specified block is not found Raises IndexError if the specified block is not found
Raises IndexError if multiple Blocks with the given name are found Raises IndexError if multiple Blocks with the given name are found
Raises ValueError if Both a block name and index are given (or none is given) Raises ValueError if Both a block name and index are given (or none is given)
Args: Args:
...@@ -219,7 +220,7 @@ class TemplateManager: ...@@ -219,7 +220,7 @@ class TemplateManager:
def remove_block(self, block_name=None, idx=None): def remove_block(self, block_name=None, idx=None):
""" """
Removes the given Instruction Block Either by name or by index Removes the given Instruction Block Either by name or by index
Raises IndexError if not the specified block is not found Raises IndexError if the specified block is not found
Raises IndexError if multiple Blocks with the given name are found Raises IndexError if multiple Blocks with the given name are found
Raises ValueError if Both a block name and index are given (or none is given) Raises ValueError if Both a block name and index are given (or none is given)
Args: Args:
...@@ -246,7 +247,7 @@ class TemplateManager: ...@@ -246,7 +247,7 @@ class TemplateManager:
def replace_block(self, new_block, block_name=None, idx=None): def replace_block(self, new_block, block_name=None, idx=None):
""" """
Removes the given Instruction Block Either by name or by index Removes the given Instruction Block Either by name or by index
Raises IndexError if not the specified block is not found Raises IndexError if the specified block is not found
Raises IndexError if multiple Blocks with the given name are found Raises IndexError if multiple Blocks with the given name are found
Raises ValueError if Both a block name and index are given (or none is given) Raises ValueError if Both a block name and index are given (or none is given)
Args: Args:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment