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
@@ -102,10 +102,10 @@ class Usecase:
:param parent: the parent context. Must be left as None (the default)
for contexts, and only set for subcontexts. Note that there are only
contexts and subcontexts, a subcontext cannot have any children.
:type parent: ifcopenshell.entity_instance.entity_instance, optional
:type parent: ifcopenshell.entity_instance, optional
:return: the newly created IfcGeometricRepresentationContext or
IfcGeometricRepresentationSubContext entity
:rtype: ifcopenshell.entity_instance.entity_instance, optional
:rtype: ifcopenshell.entity_instance, optional
Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcGeometricRepresentationContext, consult the IFC documentation.
:param context: The IfcGeometricRepresentationContext entity you want to edit
:type context: ifcopenshell.entity_instance.entity_instance
:type context: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -27,7 +27,7 @@ class Usecase:
removed. If a context is removed, then any subcontexts are also removed.
:param context: The IfcGeometricRepresentationContext entity to remove
:type context: ifcopenshell.entity_instance.entity_instance
:type context: ifcopenshell.entity_instance
:return: None
:rtype: None