Skip to content

Commit d37bef2

Browse files
committed
Document why a number of private objects are documented.
1 parent c8bb984 commit d37bef2

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/api.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ API Reference
88
:special-members: __iter__, __getitem__, __len__, __rmatmul__
99

1010

11+
Private Objects
12+
---------------
13+
14+
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).
15+
16+
They are however public in the sense that other public API functions may return objects of these types.
17+
18+
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.
19+
1120
.. autoclass:: referencing._core.Resolved
1221
:members:
1322
:undoc-members:

docs/changes.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Changelog
33
=========
44

5+
v0.30.2
6+
-------
7+
8+
* Minor docs improvement.
9+
510
v0.30.1
611
-------
712

0 commit comments

Comments
 (0)