Skip to content

Commit

Permalink
update private API blurb
Browse files Browse the repository at this point in the history
  • Loading branch information
philipc2 committed Oct 2, 2024
1 parent a92c652 commit a7c5b88
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -400,11 +400,14 @@ Accurate Computing
Private API
-----------

The following is taken from `SciPy's API reference <https://docs.scipy.org/doc/scipy/reference/#importing-from-scipy>`_


In Python, the distinction between what is the public API of a library and what
are private implementation details is not always clear. Unlike in other
languages like Java, it is possible in Python to access "private" functions or
objects. Occasionally this may be convenient, but be aware that if you do so
your code may break without warning in future releases. Some widely understood
your code may break without warning in future releases. Some widely understood
rules for what is and isn't public in Python are:

- Methods / functions / classes and module attributes whose names begin with a
Expand Down

0 comments on commit a7c5b88

Please sign in to comment.