Fix docstrings to reference datatype as it would be used for users

This commit is contained in:
Dion Moult
2024-05-06 08:39:41 +10:00
parent d694d8fcc2
commit a213ab6760
266 changed files with 439 additions and 439 deletions
@@ -51,12 +51,12 @@ class Usecase:
:type global_or_local: str
:param applied_load: The IfcStructuralLoad that is applied in this
activity.
:type applied_load: ifcopenshell.entity_instance.entity_instance
:type applied_load: ifcopenshell.entity_instance
:param structural_member: The IfcStructuralMember that the load is
applied to.
:type structural_member: ifcopenshell.entity_instance.entity_instance
:type structural_member: ifcopenshell.entity_instance
:return: The newly created entity based on the ifc_class
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
"""
self.file = file
self.settings = {
@@ -31,7 +31,7 @@ class Usecase:
A 3D analytical model is assumed.
:return: The newly created IfcStructuralAnalysisModel
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -31,13 +31,13 @@ class Usecase:
condition to. This will determine the type of condition that is
created. If no connection is supplied, an orphan boundary condition
will be created using the ifc_class that you specify.
:type connection: ifcopenshell.entity_instance.entity_instance,optional
:type connection: ifcopenshell.entity_instance,optional
:param ifc_class: The class of IfcBoundaryCondition to create, only
relevant if you do not specify a connection and want to create an
orphaned boundary condition.
:type ifc_class: str,optional
:return: The newly created IfcBoundaryCondition
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -34,7 +34,7 @@ class Usecase:
:type ifc_class: str
:return: The newly created load entity, depending on the ifc_class
specified.
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -35,7 +35,7 @@ class Usecase:
IfcActionSourceTypeEnum in the IFC documentation.
:type action_source: str
:return: The new IfcStructuralLoadCase
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
"""
self.file = file
self.settings = {
@@ -35,7 +35,7 @@ class Usecase:
IfcActionSourceTypeEnum in the IFC documentation.
:type action_source: str
:return: The new IfcStructuralLoadCase
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
"""
self.file = file
self.settings = {
@@ -26,12 +26,12 @@ class Usecase:
:param relating_structural_member: The IfcStructuralMember to have a
connection added to it.
:type relating_structural_member: ifcopenshell.entity_instance.entity_instance
:type relating_structural_member: ifcopenshell.entity_instance
:param related_structural_connection: The IfcStructuralConnection to add
to the IfcStructuralMember.
:type related_structural_connection: ifcopenshell.entity_instance.entity_instance
:type related_structural_connection: ifcopenshell.entity_instance
:return: The IfcRelConnectsStructuralMember relationship
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
"""
self.file = file
self.settings = {
@@ -25,12 +25,12 @@ class Usecase:
"""Assigns a load or structural member to an analysis model
:param product: The structural element that is part of the analysis.
:type product: ifcopenshell.entity_instance.entity_instance
:type product: ifcopenshell.entity_instance
:param structural_analysis_model: The IfcStructuralAnalysisModel that
the structural element is related to.
:type structural_analysis_model: ifcopenshell.entity_instance.entity_instance
:type structural_analysis_model: ifcopenshell.entity_instance
:return: The IfcRelAssignsToGroup relationship
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
"""
self.file = file
self.settings = {
@@ -25,7 +25,7 @@ class Usecase:
IfcStructuralAnalysisModel, consult the IFC documentation.
:param structural_analysis_model: The IfcStructuralAnalysisModel entity you want to edit
:type structural_analysis_model: ifcopenshell.entity_instance.entity_instance
:type structural_analysis_model: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -25,7 +25,7 @@ class Usecase:
IfcBoundaryCondition, consult the IFC documentation.
:param condition: The IfcBoundaryCondition entity you want to edit
:type condition: ifcopenshell.entity_instance.entity_instance
:type condition: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -22,7 +22,7 @@ class Usecase:
"""Edits the coordinate system of a structural connection
:param structural_item: The IfcStructuralItem you want to modify.
:type structural_item: ifcopenshell.entity_instance.entity_instance
:type structural_item: ifcopenshell.entity_instance
:param axis: The unit Z axis vector defined as a list of 3 floats.
Defaults to [0., 0., 1.].
:type axis: list[float]
@@ -22,7 +22,7 @@ class Usecase:
"""Edits the coordinate system of a structural connection
:param structural_item: The IfcStructuralItem you want to modify.
:type structural_item: ifcopenshell.entity_instance.entity_instance
:type structural_item: ifcopenshell.entity_instance
:param axis: The unit Z axis vector defined as a list of 3 floats.
Defaults to [0., 0., 1.].
:type axis: list[float]
@@ -25,7 +25,7 @@ class Usecase:
IfcStructuralLoad, consult the IFC documentation.
:param structural_load: The IfcStructuralLoad entity you want to edit
:type structural_load: ifcopenshell.entity_instance.entity_instance
:type structural_load: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -25,7 +25,7 @@ class Usecase:
IfcStructuralLoadCase, consult the IFC documentation.
:param load_case: The IfcStructuralLoadCase entity you want to edit
:type load_case: ifcopenshell.entity_instance.entity_instance
:type load_case: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -28,7 +28,7 @@ class Usecase:
:param structural_analysis_model: The IfcStructuralAnalysisModel to
remove.
:type structural_analysis_model: ifcopenshell.entity_instance.entity_instance
:type structural_analysis_model: ifcopenshell.entity_instance
:return: None
:rtype: None
"""
@@ -23,9 +23,9 @@ class Usecase:
:param connection: The IfcStructuralConnection to remove the condition
from. If omitted, it is assumed to be an orphaned condition.
:type connection: ifcopenshell.entity_instance.entity_instance,optional
:type connection: ifcopenshell.entity_instance,optional
:param boundary_condition: The IfcBoundaryCondition to remove.
:type boundary_condition: ifcopenshell.entity_instance.entity_instance
:type boundary_condition: ifcopenshell.entity_instance
:return: None
:rtype: None
"""
@@ -28,7 +28,7 @@ class Usecase:
The condition and the member itself is preserved.
:param relation: The IfcRelConnectsStructuralMember to remove.
:type relation: ifcopenshell.entity_instance.entity_instance
:type relation: ifcopenshell.entity_instance
:return: None
:rtype: None
"""
@@ -22,7 +22,7 @@ class Usecase:
"""Removes a structural load
:param structural_load: The IfcStructuralLoad to remove.
:type structural_load: ifcopenshell.entity_instance.entity_instance
:type structural_load: ifcopenshell.entity_instance
:return: None
:rtype: None
"""
@@ -26,7 +26,7 @@ class Usecase:
"""Removes a structural load case
:param load_case: The IfcStructuralLoadCase to remove.
:type load_case: ifcopenshell.entity_instance.entity_instance
:type load_case: ifcopenshell.entity_instance
:return: None
:rtype: None
"""
@@ -26,7 +26,7 @@ class Usecase:
"""Removes a structural load group
:param load_group: The IfcStructuralLoadGroup to remove.
:type load_group: ifcopenshell.entity_instance.entity_instance
:type load_group: ifcopenshell.entity_instance
:return: None
:rtype: None
"""
@@ -26,10 +26,10 @@ class Usecase:
"""Removes a relationship between a structural element and the analysis model
:param product: The structural element that is part of the analysis.
:type product: ifcopenshell.entity_instance.entity_instance
:type product: ifcopenshell.entity_instance
:param structural_analysis_model: The IfcStructuralAnalysisModel that
the structural element is related to.
:type structural_analysis_model: ifcopenshell.entity_instance.entity_instance
:type structural_analysis_model: ifcopenshell.entity_instance
:return: None
:rtype: None
"""