From 4a2fdabc2d1925c22a7004358ad0e1c0ea6f9e3b Mon Sep 17 00:00:00 2001 From: Abhisman Sarkar Date: Mon, 9 May 2022 23:09:58 +0530 Subject: [PATCH] Fixes #1916 The class docstring for FetcherInterface needed to clearly state that only _fetch() had to be implemented in it's implementation. This is because the public API of the interface is implemented already. Signed-off-by: Abhisman Sarkar --- docs/api/tuf.ngclient.fetcher.rst | 1 + tuf/ngclient/fetcher.py | 3 +++ 2 files changed, 4 insertions(+) diff --git a/docs/api/tuf.ngclient.fetcher.rst b/docs/api/tuf.ngclient.fetcher.rst index f37ea14f..466ff389 100644 --- a/docs/api/tuf.ngclient.fetcher.rst +++ b/docs/api/tuf.ngclient.fetcher.rst @@ -3,3 +3,4 @@ Fetcher .. automodule:: tuf.ngclient.fetcher :undoc-members: + :private-members: _fetch \ No newline at end of file diff --git a/tuf/ngclient/fetcher.py b/tuf/ngclient/fetcher.py index 3960477e..f13c8934 100644 --- a/tuf/ngclient/fetcher.py +++ b/tuf/ngclient/fetcher.py @@ -23,6 +23,9 @@ class FetcherInterface: By providing a concrete implementation of the abstract interface, users of the framework can plug-in their preferred/customized network stack. + + Implementations of FetcherInterface only need to implement ``_fetch()``. + The public API of the class is already implemented. """ __metaclass__ = abc.ABCMeta