Skip to content

Commit

Permalink
Document why a number of private objects are documented.
Browse files Browse the repository at this point in the history
  • Loading branch information
Julian committed Aug 5, 2023
1 parent c8bb984 commit d37bef2
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 5 additions & 0 deletions docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
Changelog
=========

v0.30.2
-------

* Minor docs improvement.

v0.30.1
-------

Expand Down

0 comments on commit d37bef2

Please sign in to comment.