Skip to content

Commit 40d3860

Browse files
authored
doc: document public API clearly (#3917)
1 parent 830d15e commit 40d3860

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,19 @@ If you like scverse® and want to support our mission, please consider making a
3939
</a>
4040
</div>
4141
42+
## Public API
43+
44+
Our public API is documented in the [API section][] of these docs.
45+
We cannot guarantee the stability of our internal APIs, whether it's the location of a function, its arguments, or something else.
46+
In other words, we do not officially support (or encourage users to do) something like `from scanpy.logging import debug` as `logging` is not documented, even though it does not contain a [leading underscore][].
47+
However, we are aware that many users do use these internal APIs and thus encourage them to [open an issue][] or migrate to the public API.
48+
That is, if something is missing from our public API as documented, for example a feature you wish to be exported publicly, please open an issue.
49+
50+
[api section]: https://scanpy.readthedocs.io/en/stable/api.html
51+
[leading underscore]: https://peps.python.org/pep-0008/#public-and-internal-interfaces
52+
[open an issue]: https://github.com/scverse/scanpy/issues/new/choose
53+
54+
4255

4356
## Citation
4457

0 commit comments

Comments
 (0)