From 7a6465833b6016307ef28dea45a25acc5f7a7e70 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Richard=20M=C3=B6hn?= <richard.moehn@posteo.de>
Date: Wed, 22 Apr 2015 17:42:38 +0900
Subject: [PATCH] remote.py: Denote optional parameters as such
In the online documentation to Pygit2 it was not visible that (some of)
the parameters to Remote.fetch() and Remote.push() were optional. Fix
this. (I'm not sure if the way I did it is the idiomatic way of marking
a parameter optional in Python docstrings.)
---
pygit2/remote.py | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/pygit2/remote.py b/pygit2/remote.py
index d2fbdcf..7c3b02f 100644
--- a/pygit2/remote.py
+++ b/pygit2/remote.py
@@ -178,7 +178,7 @@ class Remote(object):
check_error(err)
def fetch(self, signature=None, message=None):
- """fetch(signature, message) -> TransferProgress
+ """fetch([signature[, message]]) -> TransferProgress
Perform a fetch against this remote.
"""
@@ -296,8 +296,8 @@ class Remote(object):
protocol error or unpack failure.
:param [str] specs: push refspecs to use
- :param Signature signature: signature to use when updating the tips
- :param str message: message to use when updating the tips
+ :param Signature signature: signature to use when updating the tips (optional)
+ :param str message: message to use when updating the tips (optional)
"""
# Get the default callbacks first