summaryrefslogtreecommitdiff
path: root/python/component.py
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2023-04-12 04:05:25 -0400
committerJordan Wiens <jordan@psifertex.com>2023-04-12 04:05:25 -0400
commit4104cde86a6452bd7b371e08d9f7d3b7b420d31c (patch)
treeef1f9ed557e7efab4f6b2e4805bcd480b3540de7 /python/component.py
parentfe274619fcb187edeb2c25cc2e8b3e9a7bbc2a00 (diff)
small pydoc tweaks
Diffstat (limited to 'python/component.py')
-rw-r--r--python/component.py37
1 files changed, 19 insertions, 18 deletions
diff --git a/python/component.py b/python/component.py
index baf6f2d9..940cbe97 100644
--- a/python/component.py
+++ b/python/component.py
@@ -1,4 +1,3 @@
-
import ctypes
import inspect
from typing import Generator, Optional, List, Tuple, Union, Mapping, Any, Dict, Iterator
@@ -176,13 +175,13 @@ class Component:
@property
def components(self) -> List['Component']:
"""
- ``components`` is an iterator for all Components contained within this Component
+ ``components`` is an iterator for all Components contained within this Component
- :return: A list of components
- :Example:
+ :return: A list of components
+ :Example:
- >>> for subcomp in component.components:
- ... print(repr(component))
+ >>> for subcomp in component.components:
+ ... print(repr(component))
"""
count = ctypes.c_ulonglong(0)
@@ -199,15 +198,15 @@ class Component:
@property
def function_list(self) -> List['function.Function']:
"""
- ``function_list`` List of all Functions contained within this Component
+ ``function_list`` List of all Functions contained within this Component
- :warning: .functions Should be used instead of this in any performance sensitive context.
+ :warning: .functions Should be used instead of this in any performance sensitive context.
- :return: A list of functions
- :Example:
+ :return: A list of functions
+ :Example:
- >>> for func in component.functions:
- ... print(func.name)
+ >>> for func in component.functions:
+ ... print(func.name)
"""
count = ctypes.c_ulonglong(0)
@@ -225,12 +224,14 @@ class Component:
@property
def functions(self) -> Iterator['function.Function']:
"""
- ``functions`` is an iterator for all Functions contained within this Component
- :return: An iterator containing Components
- :rtype: ComponentIterator
- :Example:
- >>> for func in component.functions:
- ... print(func.name)
+ ``functions`` is an iterator for all Functions contained within this Component
+
+ :return: An iterator containing Components
+ :rtype: ComponentIterator
+
+ :Example:
+ >>> for func in component.functions:
+ ... print(func.name)
"""
@dataclass
class FunctionIterator: