summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/gl_objects/branches.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/gl_objects/branches.rst b/docs/gl_objects/branches.rst
index 1b61af3..50b97a7 100644
--- a/docs/gl_objects/branches.rst
+++ b/docs/gl_objects/branches.rst
@@ -41,3 +41,10 @@ Protect/unprotect a repository branch:
.. literalinclude:: branches.py
:start-after: # protect
:end-before: # end protect
+
+.. note::
+
+ By default, developers will not be able to push or merge into
+ protected branches. This can be changed by passing ``developers_can_push``
+ or ``developers_can_merge`` like so:
+ ``branch.protect(developers_can_push=False, developers_can_merge=True)``