Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-11 10:06:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
src/ifcopenshell-python/ifcopenshell/api/nest/assign_object.py
+3 -3
View File
@@ -80,13 +80,13 @@ class Usecase:
:param related_objects: The list of children of the nesting relationship,
typically IfcElements.
:type related_objects: list[ifcopenshell.entity_instance.entity_instance]
:type related_objects: list[ifcopenshell.entity_instance]
:param relating_object: The host parent of the nesting relationship,
typically an IfcElement.
:type relating_object: ifcopenshell.entity_instance.entity_instance
:type relating_object: ifcopenshell.entity_instance
:return: The IfcRelNests relationship instance
or `None` if `related_objects` was empty list.
:rtype: Union[ifcopenshell.entity_instance.entity_instance, None]
:rtype: Union[ifcopenshell.entity_instance, None]
Example:
src/ifcopenshell-python/ifcopenshell/api/nest/unassign_object.py
+1 -1
View File
@@ -32,7 +32,7 @@ class Usecase:
:param related_objects: The list of children of the nesting relationship,
typically IfcElements.
:type related_objects: list[ifcopenshell.entity_instance.entity_instance]
:type related_objects: list[ifcopenshell.entity_instance]
:return: None
:rtype: None