Unify doc-strings (remove type/rtype)

As this information is already provided in type hints and we don't need to maintain it in two places.
This commit is contained in:
Andrej730
2025-06-30 17:39:34 +05:00
parent fc10915d2b
commit 8cfd6b1754
56 changed files with 0 additions and 171 deletions
@@ -52,9 +52,7 @@ def connect_port(
and implicit connectivity is preferred for early phase design.
:param port1: The port of the first distribution element to connect.
:type port1: ifcopenshell.entity_instance
:param port2: The port of the second distribution element to connect.
:type port2: ifcopenshell.entity_instance
:param direction: The directionality of distribution flow through the
port connection. NOTDEFINED means that the direction has not yet
been determined. This is useful during preliminary system design.
@@ -63,12 +61,10 @@ def connect_port(
first element. SOURCEANDSINK means that flow is bi-directional
between the first and second element. SOURCEANDSINK is a relatively
rare scenario.
:type direction: str
:param element: Optionally set an element through which the port
connectivity is made, such as a segment or fitting. This is only to
be used for implicit port connectivity where the segments and
fittings are less important.
:type element: ifcopenshell.entity_instance, optional
Example:
@@ -28,9 +28,7 @@ def disconnect_port(file: ifcopenshell.file, port: ifcopenshell.entity_instance)
needed to be specified.
:param port: The IfcDistributionPort to disconnect.
:type port: ifcopenshell.entity_instance
:return: None
:rtype: None
Example: