mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 17:58:20 +00:00
Fix docstrings to reference datatype as it would be used for users
This commit is contained in:
@@ -37,7 +37,7 @@ class Usecase:
|
||||
this may be left as none.
|
||||
:type name: str, optional
|
||||
:return: The newly created IfcArbitraryClosedProfileDef
|
||||
:rtype: ifcopenshell.entity_instance.entity_instance
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
+1
-1
@@ -44,7 +44,7 @@ class Usecase:
|
||||
this may be left as none.
|
||||
:type name: str, optional
|
||||
:return: The newly created IfcArbitraryProfileDefWithVoids
|
||||
:rtype: ifcopenshell.entity_instance.entity_instance
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -26,13 +26,13 @@ class Usecase:
|
||||
the IFC documentation as subclasses of IfcParameterizedProfileDef.
|
||||
|
||||
Currently, this API has no benefit over directly calling
|
||||
ifcopenshell.file.file.create_entity.
|
||||
ifcopenshell.file.create_entity.
|
||||
|
||||
:param ifc_class: The subclass of IfcParameterizedProfileDef that you'd
|
||||
like to create.
|
||||
:type ifc_class: str
|
||||
:return: The newly created element depending on the specified ifc_class.
|
||||
:rtype: ifcopenshell.entity_instance.entity_instance
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ class Usecase:
|
||||
IfcProfileDef, consult the IFC documentation.
|
||||
|
||||
:param profile: The IfcProfileDef entity you want to edit
|
||||
:type profile: ifcopenshell.entity_instance.entity_instance
|
||||
:type profile: ifcopenshell.entity_instance
|
||||
:param attributes: a dictionary of attribute names and values.
|
||||
:type attributes: dict, optional
|
||||
:return: None
|
||||
|
||||
@@ -25,7 +25,7 @@ class Usecase:
|
||||
"""Removes a profile
|
||||
|
||||
:param profile: The IfcProfileDef to remove.
|
||||
:type profile: ifcopenshell.entity_instance.entity_instance
|
||||
:type profile: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
|
||||
Reference in New Issue
Block a user