Merge pull request #2002 from abs007/patch-1916

Jussi Kukkonen · web-flow · commit 46979bb46d30 · 2022-05-31T15:17:52.000+03:00
Appending Fetcher docs to state the method to be implemented.
diff --git 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
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,4 @@ Fetcher`
`3`	`3`
`4`	`4`	`.. automodule:: tuf.ngclient.fetcher`
`5`	`5`	`:undoc-members:`
	`6`	`+ :private-members: _fetch`