From d37bef22e48b7b91a10dce14904755a539bf15e1 Mon Sep 17 00:00:00 2001 From: Julian Berman Date: Sat, 5 Aug 2023 09:06:27 +0100 Subject: [PATCH] Document why a number of private objects are documented. --- docs/api.rst | 9 +++++++++ docs/changes.rst | 5 +++++ 2 files changed, 14 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index 7857468..1562a3a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -8,6 +8,15 @@ API Reference :special-members: __iter__, __getitem__, __len__, __rmatmul__ +Private Objects +--------------- + +The following objects are private in the sense that constructing or importing them is not part of the `referencing` public API, as their name indicates (by virtue of beginning with an underscore). + +They are however public in the sense that other public API functions may return objects of these types. + +Plainly then, you may rely on their methods and attributes not changing in backwards incompatible ways once `referencing` itself is stable, but may not rely on importing or constructing them yourself. + .. autoclass:: referencing._core.Resolved :members: :undoc-members: diff --git a/docs/changes.rst b/docs/changes.rst index 7ea89f1..6745742 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -2,6 +2,11 @@ Changelog ========= +v0.30.2 +------- + +* Minor docs improvement. + v0.30.1 -------