Skip to content

Commit 4a2fdab

Browse files
committed
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 <abhisman.sarkar@gmail.com>
1 parent c5ca38f commit 4a2fdab

2 files changed

Lines changed: 4 additions & 0 deletions

File tree

docs/api/tuf.ngclient.fetcher.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ Fetcher
33

44
.. automodule:: tuf.ngclient.fetcher
55
:undoc-members:
6+
:private-members: _fetch

tuf/ngclient/fetcher.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ class FetcherInterface:
2323
By providing a concrete implementation of the abstract interface,
2424
users of the framework can plug-in their preferred/customized
2525
network stack.
26+
27+
Implementations of FetcherInterface only need to implement ``_fetch()``.
28+
The public API of the class is already implemented.
2629
"""
2730

2831
__metaclass__ = abc.ABCMeta

0 commit comments

Comments
 (0)