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
@@ -50,9 +50,9 @@ class Usecase:
connections are still valid.
:param product: The IfcProduct to copy.
:type param: ifcopenshell.entity_instance.entity_instance
:type param: ifcopenshell.entity_instance
:return: The copied product
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -52,7 +52,7 @@ class Usecase:
:param name: The name of the new element.
:type name: str,optional
:return: The newly created element based on the specified IFC class.
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -48,14 +48,14 @@ class Usecase:
this.
:param product: The IfcProduct that you want to change the class of.
:type product: ifcopenshell.entity_instance.entity_instance
:type product: ifcopenshell.entity_instance
:param ifc_class: The new IFC class you want to change it to.
:type ifc_class: str,optional
:param predefined_type: In case you want to change the predefined type
too. User defined types are also allowed, just type what you want.
:type predefined_type: str,optional
:return: The newly modified product.
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -42,7 +42,7 @@ class Usecase:
naturally, the materials, types, containers, etc themselves remain).
:param product: The element to remove.
:type product: ifcopenshell.entity_instance.entity_instance
:type product: ifcopenshell.entity_instance
:return: None
:rtype: None