fix: warning and add an exception if using class alone (#3552)

* fix: warning and add an exception if using class alone * chore: adding changelog file 3552.fixed.md [dependabot-skip] * ci: auto fixes from pre-commit.com hooks. for more information, see https://pre-commit.ci * feat: clarifying warning --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
ansys · Nov 18, 2024 · 6677797 · 6677797
1 parent d7e7981
commit 6677797
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/doc/changelog.d/3552.fixed.md b/doc/changelog.d/3552.fixed.md
@@ -0,0 +1 @@
+fix: warning and add an exception if using class alone
diff --git a/src/ansys/mapdl/core/mapdl.py b/src/ansys/mapdl/core/mapdl.py
@@ -27,7 +27,7 @@ class MapdlBase(_MapdlExtended):
     """Base MAPDL class shared across all MAPDL subclasses.
 
     .. warning:: This class should NOT be imported by itself.
-       You should always import a subclass of it
-    """
+       You should always import a subclass of it like
+       :class:`MapdlGrpc <ansys.mapdl.core.mapdl_grpc.MapdlGrpc>`
 
-    pass
+    """
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		fix: warning and add an exception if using class alone