Skip to content

Commit fc88c99

Browse files
fix: Docstrings order
1 parent 637618c commit fc88c99

File tree

4 files changed

+13
-15
lines changed

4 files changed

+13
-15
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ venv/
131131
ENV/
132132
env.bak/
133133
venv.bak/
134-
134+
.ub_venv/
135135
# Spyder project settings
136136
.spyderproject
137137
.spyproject

src/ansys/tools/visualization_interface/backends/pyvista/widgets/button.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,6 @@
3333
class Button(PlotterWidget):
3434
"""Provides the abstract class for implementing buttons in PyAnsys.
3535
36-
Notes
37-
-----
38-
This class wraps the PyVista ``add_checkbox_button_widget()`` method.
39-
4036
Parameters
4137
----------
4238
plotter : Plotter
@@ -46,6 +42,9 @@ class Button(PlotterWidget):
4642
dark_mode : bool, optional
4743
Whether to activate the dark mode or not.
4844
45+
Notes
46+
-----
47+
This class wraps the PyVista ``add_checkbox_button_widget()`` method.
4948
"""
5049

5150
def __init__(self, plotter: Plotter, button_config: tuple, dark_mode: bool = False) -> None:

src/ansys/tools/visualization_interface/backends/pyvista/widgets/ruler.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,15 @@ def __init__(self, plotter: Plotter, dark_mode: bool = False) -> None:
5656
def callback(self, state: bool) -> None:
5757
"""Remove or add the ruler widget actor upon click.
5858
59-
Notes
60-
-----
61-
This method provides a callback function for the ruler widet.
62-
It is called every time the ruler widget is clicked.
63-
6459
Parameters
6560
----------
6661
state : bool
6762
Whether the state of the button, which is inherited from PyVista, is ``True``.
6863
64+
Notes
65+
-----
66+
This method provides a callback function for the ruler widet.
67+
It is called every time the ruler widget is clicked.
6968
"""
7069
if not state and self._actor:
7170
self.plotter.remove_actor(self._actor)

src/ansys/tools/visualization_interface/backends/pyvista/widgets/screenshot.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@ def __init__(self, plotter: Plotter, dark_mode: bool = False) -> None:
5656
def callback(self, state: bool) -> None:
5757
"""Remove or add the screenshot widget actor upon click.
5858
59-
Notes
60-
-----
61-
This method provides a callback function for the screenshot widget.
62-
It is called every time the screenshot widget is clicked.
63-
6459
Parameters
6560
----------
6661
state : bool
6762
Whether the state of the button, which is inherited from PyVista, is ``True``.
6863
64+
65+
Notes
66+
-----
67+
This method provides a callback function for the screenshot widget.
68+
It is called every time the screenshot widget is clicked.
6969
"""
7070
self.plotter._pl.scene.screenshot("screenshot.png")
7171

0 commit comments

Comments
 (0)