Document compatibility policy for proto_helpers explicitly.

zmyer · Oct 10, 2016 · 6ff9d2c · 6ff9d2c
1 parent 5c17777
commit 6ff9d2c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/core/development/policy/compatibility-policy.rst b/docs/core/development/policy/compatibility-policy.rst
@@ -130,8 +130,10 @@ Test Changes
 No code or data in a test package should be imported or used by a non-test package within Twisted.
 By doing so, there's no chance anything could access these objects by going through the public API.
 
-Test code and test helpers are considered private API and it should be imported outside
+Test code and test helpers are considered private API and it should not be imported outside
 of the Twisted testing infrastructure.
+As an exception to this, :api:`twisted.test.proto_helpers` is considered a public API
+(see `#6435 <https://twistedmatrix.com/trac/ticket/6435>`_ for more discussion).
 
 
 Private Changes

diff --git a/src/twisted/topfiles/8857.doc b/src/twisted/topfiles/8857.doc
@@ -0,0 +1 @@
+twisted.test.proto_helpers is now explicitly covered by the compatibility policy.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		twisted.test.proto_helpers is now explicitly covered by the compatibility policy.