Feedback: Move warnings content out of _testing

globus · Jun 7, 2024 · ebb6591 · ebb6591
1 parent 51548d6
commit ebb6591
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 19 deletions.
diff --git a/docs/core/exceptions.rst b/docs/core/exceptions.rst
@@ -158,17 +158,3 @@ attributes should be tested before use, as in
 .. autoclass:: globus_sdk.exc.ConsentRequiredInfo
     :members:
     :show-inheritance:
-
-Warnings
---------
-
-The following warnings can be emitted by the Globus SDK to indicate a
-problem which is not necessarily an error.
-
-..  seealso::
-
-    :ref:`managing-warnings`
-
-.. autoclass:: globus_sdk.RemovedInV4Warning
-    :members:
-    :show-inheritance:
diff --git a/docs/core/index.rst b/docs/core/index.rst
@@ -11,6 +11,7 @@ Underlying components of the Globus SDK.
     responses
     paging
     exceptions
+    warnings
 
 .. toctree::
     :hidden:

diff --git a/docs/testing/warnings.rst → docs/core/warnings.rst b/docs/testing/warnings.rst → docs/core/warnings.rst
@@ -1,9 +1,13 @@
-..  _managing-warnings:
+Warnings
+========
 
-Managing warnings
-=================
+The following warnings can be emitted by the Globus SDK to indicate a
+problem, or a future change, which is not necessarily an error.
+
+.. autoclass:: globus_sdk.RemovedInV4Warning
+    :members:
+    :show-inheritance:
 
-The Globus SDK issues deprecation warnings to notify developers of upcoming changes.
 
 By default, Python will not display deprecation warnings to end users,
 but testing frameworks like pytest will enable deprecation warnings for developers.

diff --git a/docs/testing/index.rst b/docs/testing/index.rst
@@ -19,5 +19,4 @@ Globus SDK _testing
 
     getting_started
     reference
-    warnings
     methods/index