Remove redundant :type from doc-strings

Args types already covered by annotations
This commit is contained in:
Andrej730
2025-11-17 14:27:58 +05:00
parent 29ab446f8c
commit 64686dde5c
7 changed files with 0 additions and 24 deletions
@@ -54,27 +54,20 @@ class Patcher:
entire IFC model. entire IFC model.
:param x: The X coordinate to offset by in project length units. :param x: The X coordinate to offset by in project length units.
:type x: typing.Union[str, float]
:param y: The Y coordinate to offset by in project length units. :param y: The Y coordinate to offset by in project length units.
:type y: typing.Union[str, float]
:param z: The Z coordinate to offset by in project length units. :param z: The Z coordinate to offset by in project length units.
:type z: typing.Union[str, float]
:param should_rotate_first: Whether or not to rotate first and then :param should_rotate_first: Whether or not to rotate first and then
translate, or to first translate and rotate afterwards. Defaults to translate, or to first translate and rotate afterwards. Defaults to
rotate first then translate. rotate first then translate.
:type should_rotate_first: bool
:param ax: An optional angle to rotate by. If only this angle is :param ax: An optional angle to rotate by. If only this angle is
specified, it is treated as the angle to rotate in plan view (i.e. specified, it is treated as the angle to rotate in plan view (i.e.
around the Z axis). If all angle parameters are specified, then it around the Z axis). If all angle parameters are specified, then it
is treated as the angle to rotate around the X axis. Angles are in is treated as the angle to rotate around the X axis. Angles are in
decimal degrees and positive is anticlockwise. decimal degrees and positive is anticlockwise.
:type ax: typing.Union[str, float],optional
:param ay: An optional angle to rotate by for 3D rotations along the Y :param ay: An optional angle to rotate by for 3D rotations along the Y
axis. Angles are in decimal degrees and positive is anticlockwise. axis. Angles are in decimal degrees and positive is anticlockwise.
:type ay: typing.Union[str, float],optional
:param az: An optional angle to rotate by for 3D rotations along the Z :param az: An optional angle to rotate by for 3D rotations along the Z
axis. Angles are in decimal degrees and positive is anticlockwise. axis. Angles are in decimal degrees and positive is anticlockwise.
:type az: typing.Union[str, float],optional
Example: Example:
@@ -26,7 +26,6 @@ class Patcher:
All objects placed relative to the storeys will also be shifted. All objects placed relative to the storeys will also be shifted.
:param z: The Z value in project length units to offset storeys by. :param z: The Z value in project length units to offset storeys by.
:type z: typing.Union[str, float]
Example: Example:
@@ -36,7 +36,6 @@ class Patcher:
:param only_duplicates: If set to True, new GlobalIds will only be :param only_duplicates: If set to True, new GlobalIds will only be
generated for duplicate IDs. This is a safe thing to run to ensure generated for duplicate IDs. This is a safe thing to run to ensure
IFCs are valid. If False, all GlobalIds will be regenerated. IFCs are valid. If False, all GlobalIds will be regenerated.
:type only_duplicates: bool
Example: Example:
@@ -68,19 +68,13 @@ class Patcher:
points used in object placements. Choosing "Both" will replace all points used in object placements. Choosing "Both" will replace all
cartesian points regardless of use (useful if the model has both cartesian points regardless of use (useful if the model has both
large placement offsets and large geometry offsets). large placement offsets and large geometry offsets).
:type mode: str
:param automatic_offset_point: Choose, whether the offset should be :param automatic_offset_point: Choose, whether the offset should be
determined automatically or specified manually. determined automatically or specified manually.
:type automatic_offset_point: bool
:param threshold: The threshold for deciding, whether a coordinate is :param threshold: The threshold for deciding, whether a coordinate is
treated as a large coordinate. treated as a large coordinate.
:type threshold: float
:param x: The x-ordinate of the manually specified offset point. :param x: The x-ordinate of the manually specified offset point.
:type x: Union[str, float]
:param y: The y-ordinate of the manually specified offset point. :param y: The y-ordinate of the manually specified offset point.
:type y: Union[str, float]
:param z: The z-ordinate of the manually specified offset point. :param z: The z-ordinate of the manually specified offset point.
:type z: Union[str, float]
Example: Example:
@@ -32,7 +32,6 @@ class Patcher:
The reference elevation is simply a numerical attribute. The reference elevation is simply a numerical attribute.
:param elevation: The elevation to set. :param elevation: The elevation to set.
:type elevation: typing.Union[str, float]
Example: Example:
@@ -38,20 +38,14 @@ class Patcher:
Sets the world coordinate system to whatever you want. Sets the world coordinate system to whatever you want.
:param x: The X coordinate. :param x: The X coordinate.
:type x: typing.Union[str, float]
:param y: The Y coordinate. :param y: The Y coordinate.
:type y: typing.Union[str, float]
:param z: The Z coordinate. :param z: The Z coordinate.
:type z: typing.Union[str, float]
:param ax: An angle to rotate by for 3D rotations along the X axis. :param ax: An angle to rotate by for 3D rotations along the X axis.
Angles are in decimal degrees and positive is anticlockwise. Angles are in decimal degrees and positive is anticlockwise.
:type ax: typing.Union[str, float]
:param ay: An angle to rotate by for 3D rotations along the Y axis. :param ay: An angle to rotate by for 3D rotations along the Y axis.
Angles are in decimal degrees and positive is anticlockwise. Angles are in decimal degrees and positive is anticlockwise.
:type ay: typing.Union[str, float]
:param az: An angle to rotate by for 3D rotations along the Z axis. :param az: An angle to rotate by for 3D rotations along the Z axis.
Angles are in decimal degrees and positive is anticlockwise. Angles are in decimal degrees and positive is anticlockwise.
:type az: typing.Union[str, float]
Example: Example:
@@ -47,10 +47,8 @@ class Patcher:
See example bug: https://github.com/Autodesk/revit-ifc/issues/707 See example bug: https://github.com/Autodesk/revit-ifc/issues/707
:param query: Query string to filter out elements to convert, defaults to "IfcBeam" :param query: Query string to filter out elements to convert, defaults to "IfcBeam"
:type query: str
:param force_faceted_brep: Force using IfcFacetedBreps instead of IfcPolygonalFaceSets, :param force_faceted_brep: Force using IfcFacetedBreps instead of IfcPolygonalFaceSets,
defaults to `False` defaults to `False`
:type force_faceted_brep: bool
Example: Example: