Skip to content

Commit 40b96a3

Browse files
committed
more notes on breaking changes
1 parent 42ce46c commit 40b96a3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

readme.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,15 @@ Things that will **not** be considered breaking:
3535
non-guaranteed implementation detail.
3636
If you need a guarantee here, please open an issue explaining why.
3737

38+
4. Base class layouts, metaclasses
39+
The non-public base classes are considered an implementation detail.
40+
They may be removed, changed, etc. The library does not support subclassing
41+
of types provided, and only the public types should need be relied upon.
42+
43+
5. Non-explicit compatability with `weakref`
44+
Any compatability with weakref should be considered accidental **unless** a
45+
type has declared slots and includes `__weakref__` in those slots.
46+
3847
Things that will be considered a breaking change:
3948

4049
1. Removal of a symbol from ``__all__``.

0 commit comments

Comments
 (0)