Skip to content

Commit 13cd9e3

Browse files
RobPasMueRobPasMue
committed
docs: change Notes for Warning
1 parent 65fb771 commit 13cd9e3

File tree

10 files changed

+144
-144
lines changed

10 files changed

+144
-144
lines changed

‎src/ansys/geometry/core/designer/body.py‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ def name(self) -> str:
150150
def set_name(self, str) -> None:
151151
"""Set the name of the body.
152152
153-
Notes
154-
-----
153+
Warnings
154+
--------
155155
This method is only available starting on Ansys release 25R1.
156156
"""
157157
return
@@ -165,8 +165,8 @@ def fill_style(self) -> FillStyle:
165165
def set_fill_style(self, fill_style: FillStyle) -> None:
166166
"""Set the fill style of the body.
167167
168-
Notes
169-
-----
168+
Warnings
169+
--------
170170
This method is only available starting on Ansys release 25R1.
171171
"""
172172
return
@@ -175,8 +175,8 @@ def set_fill_style(self, fill_style: FillStyle) -> None:
175175
def is_suppressed(self) -> bool:
176176
"""Get the body suppression state.
177177
178-
Notes
179-
-----
178+
Warnings
179+
--------
180180
This method is only available starting on Ansys release 25R2.
181181
"""
182182
return
@@ -185,8 +185,8 @@ def is_suppressed(self) -> bool:
185185
def set_suppressed(self, suppressed: bool) -> None:
186186
"""Set the body suppression state.
187187
188-
Notes
189-
-----
188+
Warnings
189+
--------
190190
This method is only available starting on Ansys release 25R2.
191191
"""
192192
return
@@ -213,8 +213,8 @@ def set_color(
213213
Color to set the body to. This can be a string representing a color name
214214
or a tuple of RGB values in the range [0, 1] (RGBA) or [0, 255] (pure RGB).
215215
216-
Notes
217-
-----
216+
Warnings
217+
--------
218218
This method is only available starting on Ansys release 25R1.
219219
"""
220220
return
@@ -299,8 +299,8 @@ def bounding_box(self) -> BoundingBox:
299299
BoundingBox
300300
Bounding box of the body.
301301
302-
Notes
303-
-----
302+
Warnings
303+
--------
304304
This method is only available starting on Ansys release 25R2.
305305
"""
306306
return
@@ -481,8 +481,8 @@ def rotate(
481481
angle: ~pint.Quantity | Angle | Real
482482
Angle (magnitude) of the rotation.
483483
484-
Notes
485-
-----
484+
Warnings
485+
--------
486486
This method is only available starting on Ansys release 24R2.
487487
"""
488488
return
@@ -499,8 +499,8 @@ def scale(self, value: Real) -> None:
499499
value: Real
500500
Value to scale the body by.
501501
502-
Notes
503-
-----
502+
Warnings
503+
--------
504504
This method is only available starting on Ansys release 24R2.
505505
"""
506506
return
@@ -517,8 +517,8 @@ def map(self, frame: Frame) -> None:
517517
frame: Frame
518518
Structure defining the orientation of the body.
519519
520-
Notes
521-
-----
520+
Warnings
521+
--------
522522
This method is only available starting on Ansys release 24R2.
523523
"""
524524
return
@@ -535,8 +535,8 @@ def mirror(self, plane: Plane) -> None:
535535
plane: Plane
536536
Represents the mirror.
537537
538-
Notes
539-
-----
538+
Warnings
539+
--------
540540
This method is only available starting on Ansys release 24R2.
541541
"""
542542
return
@@ -555,8 +555,8 @@ def get_collision(self, body: "Body") -> CollisionType:
555555
CollisionType
556556
Enum that defines the collision state between bodies.
557557
558-
Notes
559-
-----
558+
Warnings
559+
--------
560560
This method is only available starting on Ansys release 24R2.
561561
"""
562562
return
@@ -652,8 +652,8 @@ def shell_body(self, offset: Real) -> bool:
652652
bool
653653
``True`` when successful, ``False`` when failed.
654654
655-
Notes
656-
-----
655+
Warnings
656+
--------
657657
This method is only available starting on Ansys release 25R2.
658658
"""
659659
return
@@ -674,8 +674,8 @@ def remove_faces(self, selection: Face | Iterable[Face], offset: Real) -> bool:
674674
bool
675675
``True`` when successful, ``False`` when failed.
676676
677-
Notes
678-
-----
677+
Warnings
678+
--------
679679
This method is only available starting on Ansys release 25R2.
680680
"""
681681
return
@@ -1159,8 +1159,8 @@ def set_color( # noqa: D102
11591159
def set_opacity(self, opacity: float) -> None:
11601160
"""Set the opacity of the body.
11611161
1162-
Notes
1163-
-----
1162+
Warnings
1163+
--------
11641164
This method is only available starting on Ansys release 25R2.
11651165
"""
11661166
self._grpc_client.log.debug(f"Setting body opacity of {self.id} to {opacity}.")

‎src/ansys/geometry/core/designer/component.py‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -275,8 +275,8 @@ def name(self) -> str:
275275
def name(self, value: str) -> None:
276276
"""Set the name of the component.
277277
278-
Notes
279-
-----
278+
Warnings
279+
--------
280280
This method is only available starting on Ansys release 25R2.
281281
"""
282282
self.set_name(value)
@@ -287,8 +287,8 @@ def name(self, value: str) -> None:
287287
def set_name(self, name: str) -> None:
288288
"""Set the name of the component.
289289
290-
Notes
291-
-----
290+
Warnings
291+
--------
292292
This method is only available starting on Ansys release 25R2.
293293
"""
294294
self._grpc_client.log.debug(f"Renaming component {self.id} from '{self.name}' to '{name}'.")
@@ -643,8 +643,8 @@ def sweep_sketch(
643643
Body
644644
Created body from the given sketch.
645645
646-
Notes
647-
-----
646+
Warnings
647+
--------
648648
This method is only available starting on Ansys release 24R2.
649649
"""
650650
self._grpc_client.log.debug(f"Creating a sweeping profile on {self.id}. Creating body...")
@@ -683,8 +683,8 @@ def sweep_chain(
683683
Body
684684
Created body from the given sketch.
685685
686-
Notes
687-
-----
686+
Warnings
687+
--------
688688
This method is only available starting on Ansys release 24R2.
689689
"""
690690
self._grpc_client.log.debug(f"Creating a sweeping chain on {self.id}. Creating body...")
@@ -726,8 +726,8 @@ def revolve_sketch(
726726
Body
727727
Revolved body from the given sketch.
728728
729-
Notes
730-
-----
729+
Warnings
730+
--------
731731
This method is only available starting on Ansys release 24R2.
732732
"""
733733
# Based on the reference axis and the sketch plane's normal, retrieve the orthogonal
@@ -826,8 +826,8 @@ def create_sphere(self, name: str, center: Point3D, radius: Distance) -> Body:
826826
Body
827827
Sphere body object.
828828
829-
Notes
830-
-----
829+
Warnings
830+
--------
831831
This method is only available starting on Ansys release 24R2.
832832
"""
833833
self._grpc_client.log.debug(f"Creating a sphere body on {self.id}.")
@@ -885,8 +885,8 @@ def create_body_from_loft_profile(
885885
Body
886886
Created lofted body object.
887887
888-
Notes
889-
-----
888+
Warnings
889+
--------
890890
This method is only available starting on Ansys release 24R2.
891891
"""
892892
self._grpc_client.log.debug(f"Creating a loft profile body on {self.id}.")
@@ -979,8 +979,8 @@ def create_body_from_surface(self, name: str, trimmed_surface: TrimmedSurface) -
979979
Body
980980
Surface body.
981981
982-
Notes
983-
-----
982+
Warnings
983+
--------
984984
This method is only available starting on Ansys release 25R1.
985985
"""
986986
self._grpc_client.log.debug(
@@ -1012,8 +1012,8 @@ def create_surface_from_trimmed_curves(
10121012
Body
10131013
Surface body.
10141014
1015-
Notes
1016-
-----
1015+
Warnings
1016+
--------
10171017
This method is only available starting on Ansys release 24R2.
10181018
"""
10191019
self._grpc_client.log.debug(

‎src/ansys/geometry/core/designer/design.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -784,8 +784,8 @@ def get_all_parameters(self) -> list[Parameter]:
784784
list[Parameter]
785785
List of parameters for the design.
786786
787-
Notes
788-
-----
787+
Warnings
788+
--------
789789
This method is only available starting on Ansys release 25R1.
790790
"""
791791
response = self._grpc_client._services.driving_dimensions.get_all_parameters()
@@ -806,8 +806,8 @@ def set_parameter(self, dimension: Parameter) -> ParameterUpdateStatus:
806806
ParameterUpdateStatus
807807
Status of the update operation.
808808
809-
Notes
810-
-----
809+
Warnings
810+
--------
811811
This method is only available starting on Ansys release 25R1.
812812
"""
813813
response = self._grpc_client._services.driving_dimensions.set_parameter(
@@ -944,8 +944,8 @@ def insert_file(
944944
Component
945945
The newly inserted component.
946946
947-
Notes
948-
-----
947+
Warnings
948+
--------
949949
This method is only available starting on Ansys release 24R2.
950950
"""
951951
# Upload the file to the server

‎src/ansys/geometry/core/designer/edge.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ def shape(self) -> TrimmedCurve:
117117
start and end points of the curve and handles parameters to allow evaluation as if the
118118
curve is not reversed.
119119
120-
Notes
121-
-----
120+
Warnings
121+
--------
122122
This method is only available starting on Ansys release 24R2.
123123
"""
124124
if self._shape is None:
@@ -206,8 +206,8 @@ def end(self) -> Point3D:
206206
def bounding_box(self) -> BoundingBox:
207207
"""Bounding box of the edge.
208208
209-
Notes
210-
-----
209+
Warnings
210+
--------
211211
This method is only available starting on Ansys release 25R2.
212212
"""
213213
self._grpc_client.log.debug("Requesting bounding box from server.")

‎src/ansys/geometry/core/designer/face.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@ def shape(self) -> TrimmedSurface:
211211
If the face is reversed, its shape is a ``ReversedTrimmedSurface`` type, which handles the
212212
direction of the normal vector to ensure it is always facing outward.
213213
214-
Notes
215-
-----
214+
Warnings
215+
--------
216216
This method is only available starting on Ansys release 24R2.
217217
"""
218218
if self._shape is None:
@@ -300,8 +300,8 @@ def loops(self) -> list[FaceLoop]:
300300
def color(self) -> str:
301301
"""Get the current color of the face.
302302
303-
Notes
304-
-----
303+
Warnings
304+
--------
305305
This method is only available starting on Ansys release 25R2.
306306
"""
307307
if self._color is None and self.body.is_alive:
@@ -338,8 +338,8 @@ def opacity(self, opacity: float) -> None:
338338
def bounding_box(self) -> BoundingBox:
339339
"""Get the bounding box for the face.
340340
341-
Notes
342-
-----
341+
Warnings
342+
--------
343343
This method is only available starting on Ansys release 25R2.
344344
"""
345345
self._grpc_client.log.debug(f"Getting bounding box for {self.id}.")
@@ -353,8 +353,8 @@ def bounding_box(self) -> BoundingBox:
353353
def set_color(self, color: str | tuple[float, float, float]) -> None:
354354
"""Set the color of the face.
355355
356-
Notes
357-
-----
356+
Warnings
357+
--------
358358
This method is only available starting on Ansys release 25R2.
359359
"""
360360
self._grpc_client.log.debug(f"Setting face color of {self.id} to {color}.")
@@ -370,8 +370,8 @@ def set_color(self, color: str | tuple[float, float, float]) -> None:
370370
def set_opacity(self, opacity: float) -> None:
371371
"""Set the opacity of the face.
372372
373-
Notes
374-
-----
373+
Warnings
374+
--------
375375
This method is only available starting on Ansys release 25R2.
376376
"""
377377
self._grpc_client.log.debug(f"Setting face color of {self.id} to {opacity}.")
@@ -510,8 +510,8 @@ def setup_offset_relationship(
510510
bool
511511
``True`` when successful, ``False`` when failed.
512512
513-
Notes
514-
-----
513+
Warnings
514+
--------
515515
This method is only available starting on Ansys release 25R2.
516516
"""
517517
result = self._commands_stub.FaceOffset(

0 commit comments

Comments
 (0)