mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-09 09:21:46 +00:00
Unify doc-strings (remove type/rtype)
As this information is already provided in type hints and we don't need to maintain it in two places.
This commit is contained in:
@@ -28,9 +28,7 @@ def remove_group(file: ifcopenshell.file, group: ifcopenshell.entity_instance) -
|
||||
the group will be removed.
|
||||
|
||||
:param group: The IfcGroup entity you want to remove
|
||||
:type group: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -29,11 +29,8 @@ def unassign_group(
|
||||
If the product isn't assigned to the group, nothing will happen.
|
||||
|
||||
:param products: A list of IfcProduct elements to unassign from the group
|
||||
:type products: list[ifcopenshell.entity_instance]
|
||||
:param group: The IfcGroup to unassign from
|
||||
:type group: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -31,11 +31,8 @@ def update_group_products(
|
||||
removed.
|
||||
|
||||
:param products: A list of IfcProduct elements to assign to the group
|
||||
:type products: list[ifcopenshell.entity_instance]
|
||||
:param group: The IfcGroup to assign the products to
|
||||
:type group: ifcopenshell.entity_instance
|
||||
:return: The IfcRelAssignsToGroup relationship
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user