mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-13 10:57:49 +00:00
Fix docstrings to reference datatype as it would be used for users
This commit is contained in:
@@ -36,7 +36,7 @@ class Usecase:
|
||||
:param Name: The name of the layer. Defaults to "Unnamed".
|
||||
:type Name: str, optional
|
||||
:return: The newly created IfcPresentationLayerAssignment element
|
||||
:rtype: ifcopenshell.entity_instance.entity_instance
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -34,10 +34,10 @@ class Usecase:
|
||||
|
||||
:param items: The list of IfcRepresentationItems to assign to the layer. This
|
||||
should be the items from the object's IfcShapeRepresentation.
|
||||
:type items: list[ifcopenshell.entity_instance.entity_instance]
|
||||
:type items: list[ifcopenshell.entity_instance]
|
||||
:param layer: The IfcPresentationLayerAssignment layer to assign the
|
||||
item to.
|
||||
:type layer: ifcopenshell.entity_instance.entity_instance
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ class Usecase:
|
||||
IfcPresentationLayerAssignment, consult the IFC documentation.
|
||||
|
||||
:param layer: The IfcPresentationLayerAssignment 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
|
||||
:return: None
|
||||
|
||||
@@ -25,7 +25,7 @@ class Usecase:
|
||||
relationship to the layer will be removed.
|
||||
|
||||
:param layer: The IfcPresentationLayerAssignment entity to remove
|
||||
:type layer: ifcopenshell.entity_instance.entity_instance
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
|
||||
@@ -32,9 +32,9 @@ class Usecase:
|
||||
removed to keep IFC valid.
|
||||
|
||||
:param items: A list IfcRepresentationItem elements to unassign
|
||||
:type items: list[ifcopenshell.entity_instance.entity_instance]
|
||||
:type items: list[ifcopenshell.entity_instance]
|
||||
:param layer: The IfcPresentationLayerAssignment to unassign from
|
||||
:type layer: ifcopenshell.entity_instance.entity_instance
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
|
||||
Reference in New Issue
Block a user