Skip to content

Commit 8e1f667

Browse files
committed
Add a note on spec-incorrect behavior.
1 parent b419b5f commit 8e1f667

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/compatibility.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ Compatibility
55
``referencing`` is currently in beta so long as version numbers begin with a ``0``, meaning its public interface may change if issues are uncovered, though not typically without reason.
66
Once it seems clear that the interfaces look correct (likely after ``referencing`` is in use for some period of time) versioning will move to `CalVer <https://calver.org/>`_ and interfaces will not change in backwards-incompatible ways without deprecation periods.
77

8+
.. note::
9+
10+
Backwards compatibility is always defined relative to the specifications we implement.
11+
Changing a behavior which is incorrect according to the relevant referencing specifications is not considered a backwards-incompatible change -- on the contrary, it's considered a bug fix.
12+
813
In the spirit of `having some explicit detail on Bowtie's public interfaces <regret:before-you-deprecate:document your public api>`, here is a non-exhaustive list of things which are *not* part of the ``referencing`` public interface, and therefore which may change without warning, even once no longer in beta:
914

1015
* All commonly understood indicators of privacy in Python -- in particular, (sub)packages, modules and identifiers beginning with a single underscore.

0 commit comments

Comments
 (0)