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
@@ -57,7 +57,7 @@ class Usecase:
:param pset_template: The property set template to add the property
template to.
:type pset_template: ifcopenshell.entity_instance.entity_instance
:type pset_template: ifcopenshell.entity_instance
:param name: The name of the property
:type name: str,optional
:param description: A few words describing what the property stores.
@@ -66,7 +66,7 @@ class Usecase:
IFC documentation for the full list of data types.
:param primary_measure_type: str,optional
:return: The newly created IfcSimplePropertyTemplate.
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -84,7 +84,7 @@ class Usecase:
property set may be assigned to any type.
:type applicable_entity: str,optional
:return: The newly created IfcPropertySetTemplate
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcSimplePropertyTemplate, consult the IFC documentation.
:param prop_template: The IfcSimplePropertyTemplate entity you want to edit
:type prop_template: ifcopenshell.entity_instance.entity_instance
:type prop_template: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -25,7 +25,7 @@ class Usecase:
IfcPropertySetTemplate, consult the IFC documentation.
:param pset_template: The IfcPropertySetTemplate entity you want to edit
:type pset_template: ifcopenshell.entity_instance.entity_instance
:type pset_template: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -28,7 +28,7 @@ class Usecase:
templates.
:param prop_template: The IfcSimplePropertyTemplate to remove.
:type prop_template: ifcopenshell.entity_instance.entity_instance
:type prop_template: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -27,7 +27,7 @@ class Usecase:
along with it.
:param pset_template: The IfcPropertySetTemplate to remove.
:type pset_template: ifcopenshell.entity_instance.entity_instance
:type pset_template: ifcopenshell.entity_instance
:return: None
:rtype: None