Skip to content

Commit 7324c37

Browse files
docs: typo with the docstrings (#1524)
Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
1 parent cf0d150 commit 7324c37

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

doc/changelog.d/1524.documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
typo with the docstrings

src/ansys/geometry/core/shapes/surfaces/plane.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
# SOFTWARE.
22-
"""Provides for creating and managing a cylinder."""
22+
"""Provides for creating and managing a plane."""
2323

2424
from functools import cached_property
2525

@@ -73,22 +73,22 @@ def __init__(
7373

7474
@property
7575
def origin(self) -> Point3D:
76-
"""Origin of the cylinder."""
76+
"""Origin of the plane."""
7777
return self._origin
7878

7979
@property
8080
def dir_x(self) -> UnitVector3D:
81-
"""X-direction of the cylinder."""
81+
"""X-direction of the plane."""
8282
return self._reference
8383

8484
@property
8585
def dir_y(self) -> UnitVector3D:
86-
"""Y-direction of the cylinder."""
86+
"""Y-direction of the plane."""
8787
return self.dir_z.cross(self.dir_x)
8888

8989
@property
9090
def dir_z(self) -> UnitVector3D:
91-
"""Z-direction of the cylinder."""
91+
"""Z-direction of the plane."""
9292
return self._axis
9393

9494
@check_input_types

0 commit comments

Comments
 (0)