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
@@ -38,11 +38,11 @@ class Usecase:
constituent is part of. The constituent set represents a group of
constituents. See ifcopenshell.api.material.add_material_set for
information on how to add a constituent set.
:type constituent_set: ifcopenshell.entity_instance.entity_instance
:type constituent_set: ifcopenshell.entity_instance
:param material: The IfcMaterial that the constituent is made out of.
:type material: ifcopenshell.entity_instance.entity_instance
:type material: ifcopenshell.entity_instance
:return: The newly created IfcMaterialConstituent
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -36,11 +36,11 @@ class Usecase:
layer set represents a group of layers. See
ifcopenshell.api.material.add_material_set for more information on
how to add a layer set.
:type layer_set: ifcopenshell.entity_instance.entity_instance
:type layer_set: ifcopenshell.entity_instance
:param material: The IfcMaterial that the layer is made out of.
:type material: ifcopenshell.entity_instance.entity_instance
:type material: ifcopenshell.entity_instance
:return: The newly created IfcMaterialLayer
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -39,9 +39,9 @@ class Usecase:
:param material_list: The IfcMaterialList the material should be added
to.
:type material_list: ifcopenshell.entity_instance.entity_instance
:type material_list: ifcopenshell.entity_instance
:param material: The IfcMaterial to add to the list
:type material: ifcopenshell.entity_instance.entity_instance
:type material: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -53,7 +53,7 @@ class Usecase:
:param category: The category of the material.
:type category: str, optional
:return: The newly created IfcMaterial
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -64,7 +64,7 @@ class Usecase:
IfcMaterialConstituentSet.
:type set_type: str, optional
:return: The newly created material set element
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -47,14 +47,14 @@ class Usecase:
profile set represents a group of profile items. See
ifcopenshell.api.material.add_material_set for more information on
how to add a profile set.
:type profile_set: ifcopenshell.entity_instance.entity_instance
:type profile_set: ifcopenshell.entity_instance
:param material: The IfcMaterial that the profile item is made out of.
:type material: ifcopenshell.entity_instance.entity_instance, optional
:type material: ifcopenshell.entity_instance, optional
:param profile: The IfcProfileDef that represents the 2D cross section
of the the profile item.
:type profile: ifcopenshell.entity_instance.entity_instance, optional
:type profile: ifcopenshell.entity_instance, optional
:return: The newly created IfcMaterialProfile
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -64,7 +64,7 @@ class Usecase:
:param products: The list of IfcProducts to assign the material or material set
to.
:type products: list[ifcopenshell.entity_instance.entity_instance]
:type products: list[ifcopenshell.entity_instance]
:param type: Choose from "IfcMaterial", "IfcMaterialConstituentSet",
"IfcMaterialLayerSet", "IfcMaterialLayerSetUsage",
"IfcMaterialProfileSet", "IfcMaterialProfileSetUsage", or
@@ -74,15 +74,15 @@ class Usecase:
:param material: The IfcMaterial or material set you are assigning here.
If type is Usage then no need to provide `material`, it will be deduced
from the element type automatically.
:type material: ifcopenshell.entity_instance.entity_instance, optional
:type material: ifcopenshell.entity_instance, optional
:return: IfcRelAssociatesMaterial entity
or a list of IfcRelAssociatesMaterial entities
(possible if `type` is Usage
and `products` require different Usages)
or `None` if `products` was empty list.
:rtype: Union[
ifcopenshell.entity_instance.entity_instance,
list[ifcopenshell.entity_instance.entity_instance], None]
ifcopenshell.entity_instance,
list[ifcopenshell.entity_instance], None]
Example:
@@ -29,9 +29,9 @@ class Usecase:
:param material_profile: The IfcMaterialProfile to change the profile
curve of. See ifcopenshell.api.material.add_profile to see how to
create profiles.
:type material_profile: ifcopenshell.entity_instance.entity_instance
:type material_profile: ifcopenshell.entity_instance
:param profile: The IfcProfileDef to set the profile item's curve to.
:type profile: ifcopenshell.entity_instance.entity_instance
:type profile: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -28,9 +28,9 @@ class Usecase:
associated to any elements.
:param material: The IfcMaterial to copy
:type material: ifcopenshell.entity_instance.entity_instance
:type material: ifcopenshell.entity_instance
:return: The new copy of the material
:rtype: ifcopenshell.entity_instance.entity_instance
:rtype: ifcopenshell.entity_instance
Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcMaterial, consult the IFC documentation.
:param element: The IfcMaterial entity you want to edit
:type element: ifcopenshell.entity_instance.entity_instance
:type element: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -25,11 +25,11 @@ class Usecase:
IfcMaterialConstituent, consult the IFC documentation.
:param constituent: The IfcMaterialConstituent entity you want to edit
:type constituent: ifcopenshell.entity_instance.entity_instance
:type constituent: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:param material: The IfcMaterial entity you want to change the constituent to
:type material: ifcopenshell.entity_instance.entity_instance, optional
:type material: ifcopenshell.entity_instance, optional
:return: None
:rtype: None
@@ -25,12 +25,12 @@ class Usecase:
IfcMaterialLayer, consult the IFC documentation.
:param layer: The IfcMaterialLayer entity you want to edit
:type layer: ifcopenshell.entity_instance.entity_instance
:type layer: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:param material: The IfcMaterial entity you want the layer to be made
from.
:type material: ifcopenshell.entity_instance.entity_instance, optional
:type material: ifcopenshell.entity_instance, optional
:return: None
:rtype: None
@@ -28,7 +28,7 @@ class Usecase:
IfcMaterialLayerSetUsage, consult the IFC documentation.
:param usage: The IfcMaterialLayerSetUsage entity you want to edit
:type usage: ifcopenshell.entity_instance.entity_instance
:type usage: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -25,15 +25,15 @@ class Usecase:
IfcMaterialProfile, consult the IFC documentation.
:param profile: The IfcMaterialProfile 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
:param profile_def: The IfcProfileDef entity the profile curve should be
extruded from.
:type profile_def: ifcopenshell.entity_instance.entity_instance, optional
:type profile_def: ifcopenshell.entity_instance, optional
:param material: The IfcMaterial entity you want to change the profile
to be made from.
:type material: ifcopenshell.entity_instance.entity_instance, optional
:type material: ifcopenshell.entity_instance, optional
:return: None
:rtype: None
@@ -33,7 +33,7 @@ class Usecase:
IfcMaterialProfileSetUsage, consult the IFC documentation.
:param usage: The IfcMaterialProfileSetUsage entity you want to edit
:type usage: ifcopenshell.entity_instance.entity_instance
:type usage: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
@@ -25,7 +25,7 @@ class Usecase:
at least one constituent to ensure a valid IFC dataset.
:param constituent: The IfcMaterialConstituent entity you want to remove
:type constituent: ifcopenshell.entity_instance.entity_instance
:type constituent: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -25,7 +25,7 @@ class Usecase:
at least one layer to ensure a valid IFC dataset.
:param layer: The IfcMaterialLayer entity you want to remove
:type layer: ifcopenshell.entity_instance.entity_instance
:type layer: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -28,7 +28,7 @@ class Usecase:
:param material_list: The IfcMaterialList entity you want to remove an
item from.
:type material_list: ifcopenshell.entity_instance.entity_instance
:type material_list: ifcopenshell.entity_instance
:param material_index: The index of the material you want to remove from
the list. Starts counting at 0. Defaults to 0.
:type material_index: int, optional
@@ -30,7 +30,7 @@ class Usecase:
take care of this situation themselves.
:param material: The IfcMaterial entity you want to remove
:type material: ifcopenshell.entity_instance.entity_instance
:type material: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -30,7 +30,7 @@ class Usecase:
:param material: The IfcMaterialLayerSet, IfcMaterialConstituentSet,
IfcMaterialProfileSet entity you want to remove.
:type material: ifcopenshell.entity_instance.entity_instance
:type material: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -29,7 +29,7 @@ class Usecase:
at least one profile to ensure a valid IFC dataset.
:param profile: The IfcMaterialProfile entity you want to remove
:type profile: ifcopenshell.entity_instance.entity_instance
:type profile: ifcopenshell.entity_instance
:return: None
:rtype: None
@@ -26,7 +26,7 @@ class Usecase:
:param material_set: The IfcMaterialSet which you want to reorder an
item in.
:type material_set: ifcopenshell.entity_instance.entity_instance
:type material_set: ifcopenshell.entity_instance
:param old_index: The index of the item you want to move. This starts
counting from 0.
:type old_index: int
@@ -32,7 +32,7 @@ class Usecase:
If the product does not have a material, nothing happens.
:param products: The list IfcProducts that may or may not have a material
:type product: list[ifcopenshell.entity_instance.entity_instance]
:type product: list[ifcopenshell.entity_instance]
:return: None
:rtype: None