Brief branch protection notes

vilhelmen · vilhelmen · commit 8a560c6ada94 · 2016-09-14T19:03:29.000-05:00
You can pass developers_can_push and developers_can_merge to the protect function. Handy!
diff --git 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)``
