Extend comment of Remote.push by note about push_update_reference.

mrh1997 · mrh1997 · commit ee28de65a009 · 2016-10-23T23:55:53.000+02:00
As happened in support request libgit2/libgit2#3963 it can be easily overseen, that push returns True, when the remote has installed a hook that denies the commits.
diff --git a/pygit2/remote.py b/pygit2/remote.py
@@ -413,6 +413,12 @@ def push(self, specs, callbacks=None):
         """Push the given refspec to the remote. Raises ``GitError`` on
         protocol error or unpack failure.
 
+        When the remote has a githook installed, that denies the reference
+        this function will return successfully. Thus it is stronly recommended
+        to install a callback, that implements
+        :py:meth:`RemoteCallbacks.push_update_reference` and check the passed
+        parameters for successfull operations.
+
         :param [str] specs: push refspecs to use
         """
         push_opts = ffi.new('git_push_options *')
