Skip to content

Commit ec68cb2

Browse files
committed
more breaking policy details
1 parent f7127ba commit ec68cb2

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ Things that will **not** be considered breaking:
4343
5. Non-explicit compatability with `weakref`
4444
Any compatability with weakref should be considered accidental **unless** a
4545
type has declared slots and includes `__weakref__` in those slots.
46+
(open an issue if you want `__weakref__` with a reason why)
47+
48+
6. Going from *inable* to *able* share a resource across threads.
49+
7. Adding or removing internal locking that does not introduce deadlocks,
50+
races, or remove the threadsafety of an object's documented use.
4651

4752
Things that will be considered a breaking change:
4853

@@ -53,6 +58,7 @@ Things that will be considered a breaking change:
5358
5. Changing the semantic meaning of a parameter's default value.
5459
6. Changing the allowed runtime type of a parameter in a way that makes a previously supported call invalid.
5560
7. Changing the runtime return type of a documented function to no longer match prior documentation.
61+
8. Changing an object to no longer be shareable across threads.
5662

5763
When something isn't covered explicitly one way or the other above,
5864
it will be considered a breaking change if an intended supported usage

0 commit comments

Comments
 (0)