mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 09:48:32 +00:00
Fix docstrings to reference datatype as it would be used for users
This commit is contained in:
@@ -39,18 +39,18 @@ class Usecase:
|
||||
Do not mix units.
|
||||
|
||||
:param library: The file object containing the asset.
|
||||
:type library: ifcopenshell.file.file
|
||||
:type library: ifcopenshell.file
|
||||
:param element: An element in the library file of the asset. It may be
|
||||
an IfcTypeProduct, IfcProduct, IfcMaterial, IfcCostSchedule, or
|
||||
IfcProfileDef.
|
||||
:type element: ifcopenshell.entity_instance.entity_instance
|
||||
:type element: ifcopenshell.entity_instance
|
||||
:param reuse_identities: Optional dictionary of mapped entities' identities to the
|
||||
already created elements. It will be used to avoid creating
|
||||
duplicated inverse elements during multiple `project.append_asset` calls. If you want
|
||||
to add just 1 asset or if added assets won't have any shared elements, then it can be left empty.
|
||||
:type reuse_identities: dict[int, ifcopenshell.entity_instance.entity_instance]
|
||||
:type reuse_identities: dict[int, ifcopenshell.entity_instance]
|
||||
:return: The appended element
|
||||
:rtype: ifcopenshell.entity_instance.entity_instance
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -43,13 +43,13 @@ class Usecase:
|
||||
a declaration lets you say that an object belongs to a library.
|
||||
|
||||
:param definitions: The list of objects you want to declare. Typically a list of assets.
|
||||
:type definitions: list[ifcopenshell.entity_instance.entity_instance]
|
||||
:type definitions: list[ifcopenshell.entity_instance]
|
||||
:param relating_context: The IfcProject, or more commonly the
|
||||
IfcProjectLibrary that you want the object to be part of.
|
||||
:type relating_context: ifcopenshell.entity_instance.entity_instance
|
||||
:type relating_context: ifcopenshell.entity_instance
|
||||
:return: The new IfcRelDeclares relationship or None if all definitions
|
||||
were already declared / do not support declaration.
|
||||
:rtype: Union[ifcopenshell.entity_instance.entity_instance, None]
|
||||
:rtype: Union[ifcopenshell.entity_instance, None]
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ class Usecase:
|
||||
schema, you may specify that schema identifier here too.
|
||||
:type version: str, optional
|
||||
:return: The created IFC file object.
|
||||
:rtype: ifcopenshell.file.file
|
||||
:rtype: ifcopenshell.file
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -34,10 +34,10 @@ class Usecase:
|
||||
|
||||
:param definitions: The list of objects you want to undeclare.
|
||||
Typically a list of assets.
|
||||
:type definitions: list[ifcopenshell.entity_instance.entity_instance]
|
||||
:type definitions: list[ifcopenshell.entity_instance]
|
||||
:param relating_context: The IfcProject, or more commonly the
|
||||
IfcProjectLibrary that you want the object to no longer be part of.
|
||||
:type relating_context: ifcopenshell.entity_instance.entity_instance
|
||||
:type relating_context: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
|
||||
Reference in New Issue
Block a user