diff options
author | Hugo van Kemenade <hugovk@users.noreply.github.com> | 2021-08-19 12:22:22 +0300 |
---|---|---|
committer | Sebastian Thiel <sebastian.thiel@icloud.com> | 2021-08-19 18:39:13 +0800 |
commit | 1003c6612e0ee8973ba701e317b7308b7d0136aa (patch) | |
tree | c217505e3d7bb94a4a6b7172305ee7c5cbec70d1 | |
parent | dff15cd8ba473776f76e8a3b6359a861e72d74aa (diff) | |
download | gitdb-1003c6612e0ee8973ba701e317b7308b7d0136aa.tar.gz |
Fix Sphinx warnings
-rw-r--r-- | doc/source/conf.py | 2 | ||||
-rw-r--r-- | gitdb/db/base.py | 5 | ||||
-rw-r--r-- | gitdb/db/mem.py | 1 |
3 files changed, 7 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 68d9a3f..3ab15ab 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -120,7 +120,7 @@ html_theme_options = { # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['.static'] +#html_static_path = ['.static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/gitdb/db/base.py b/gitdb/db/base.py index 2d7b9fa..f0b8a05 100644 --- a/gitdb/db/base.py +++ b/gitdb/db/base.py @@ -33,6 +33,9 @@ class ObjectDBR(object): #{ Query Interface def has_object(self, sha): """ + Whether the object identified by the given 20 bytes + binary sha is contained in the database + :return: True if the object identified by the given 20 bytes binary sha is contained in the database""" raise NotImplementedError("To be implemented in subclass") @@ -82,6 +85,8 @@ class ObjectDBW(object): def ostream(self): """ + Return the output stream + :return: overridden output stream this instance will write to, or None if it will write to the default stream""" return self._ostream diff --git a/gitdb/db/mem.py b/gitdb/db/mem.py index 5b242e4..212a68f 100644 --- a/gitdb/db/mem.py +++ b/gitdb/db/mem.py @@ -92,6 +92,7 @@ class MemoryDB(ObjectDBR, ObjectDBW): """Copy the streams as identified by sha's yielded by sha_iter into the given odb The streams will be copied directly **Note:** the object will only be written if it did not exist in the target db + :return: amount of streams actually copied into odb. If smaller than the amount of input shas, one or more objects did already exist in odb""" count = 0 |