diff --git a/docs/core/exceptions.rst b/docs/core/exceptions.rst index 49457a74b..70837a349 100644 --- 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 index 6d6ffe1e8..f0ff8e50c 100644 --- 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 b/docs/core/warnings.rst similarity index 92% rename from docs/testing/warnings.rst rename to docs/core/warnings.rst index 2a7058909..89c33e2d7 100644 --- a/docs/testing/warnings.rst +++ b/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 index d863842d3..9de0abb21 100644 --- a/docs/testing/index.rst +++ b/docs/testing/index.rst @@ -19,5 +19,4 @@ Globus SDK _testing getting_started reference - warnings methods/index