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
@@ -53,7 +53,7 @@ class Usecase:
data, rather than arbitrary metadata.
:param product: The IfcObject that you want to assign a property set to.
:type product: ifcopenshell.entity_instance.entity_instance
:type product: ifcopenshell.entity_instance
:param name: The name of the property set. Property sets that are
standardised by buildingSMART typically have a prefix of "Pset_",
like "Pset_WallCommon". If you create your own, you must not use
@@ -61,7 +61,7 @@ class Usecase:
your project, company, or local government requirement.
:type name: str
:return: The newly created IfcPropertySet
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -49,7 +49,7 @@ class Usecase:
metadata, rather than quantification data.
:param product: The IfcObject that you want to assign a quantity set to.
:type product: ifcopenshell.entity_instance.entity_instance
:type product: ifcopenshell.entity_instance
:param name: The name of the quantity set. Quantity sets that are
standardised by buildingSMART typically have a prefix of "Qto_",
like "Qto_WallBaseQuantities". If you create your own, you must not
@@ -57,7 +57,7 @@ class Usecase:
to your project, company, or local government requirement.
:type name: str
:return: The newly created IfcElementQuantity
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -52,7 +52,7 @@ class Usecase:
to ensure that data types are always consistent and correct.
:param pset: The IfcPropertySet to edit.
:type pset: ifcopenshell.entity_instance.entity_instance
:type pset: ifcopenshell.entity_instance
:param name: A new name for the property set. If no name is specified,
the property set name is not changed.
:type name: str, optional
@@ -69,7 +69,7 @@ class Usecase:
:param pset_template: If a property set template is provided, this will
be used to determine data types. If no user-defined template is
provided, the built-in buildingSMART templates will be loaded.
:type pset_template: ifcopenshell.entity_instance.entity_instance
:type pset_template: ifcopenshell.entity_instance
:param should_purge: If left as False, properties set to None will be
left as None but not removed. If set to true, properties set to None
will actually be removed.
@@ -34,7 +34,7 @@ class Usecase:
It is not allowed to have None quantities in IFC.
:param qto: The IfcElementQuantity to edit.
:type qto: ifcopenshell.entity_instance.entity_instance
:type qto: ifcopenshell.entity_instance
:param name: A new name for the quantity set. If no name is specified,
the quantity set name is not changed.
:type name: str, optional
@@ -51,7 +51,7 @@ class Usecase:
:param pset_template: If a quantity set template is provided, this will
be used to determine data types. If no user-defined template is
provided, the built-in buildingSMART templates will be loaded.
:type pset_template: ifcopenshell.entity_instance.entity_instance
:type pset_template: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -27,9 +27,9 @@ class Usecase:
All properties that are part of this property set are also removed.
:param product: The IfcObject to remove the property set from.
:type product: ifcopenshell.entity_instance.entity_instance
:type product: ifcopenshell.entity_instance
:param pset: The IfcPropertySet or IfcElementQuantity to remove.
:type pset: ifcopenshell.entity_instance.entity_instance
:type pset: ifcopenshell.entity_instance
:return: None
:rtype: None