docs: Improve ngclient docs

Signed-off-by: Jussi Kukkonen <[email protected]>
theupdateframework · Aug 23, 2021 · 842746e · 842746e
1 parent 27bbcb1
commit 842746e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/docs/api/tuf.ngclient.rst b/docs/api/tuf.ngclient.rst
@@ -1,8 +1,15 @@
 ngclient
 ========
 
+The ngclient module contains a complete TUF client library implementation.
+
+* :doc:`tuf.ngclient.updater` implements the client update workflow
+* :doc:`tuf.ngclient.config` provides optional configuration for the updater
+* :doc:`tuf.ngclient.fetcher` can be used for optional low-level network I/O control
+
+
 .. toctree::
-   :maxdepth: 4
+   :hidden:
 
    tuf.ngclient.updater
    tuf.ngclient.config

diff --git a/tuf/ngclient/updater.py b/tuf/ngclient/updater.py
@@ -1,9 +1,9 @@
 # Copyright 2020, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-"""TUF module that implements the client update workflow.
+"""Client update workflow implementation
 
-This module contains the Updater class that provides an implementation of the
+The Updater class provides an implementation of the
 `TUF client workflow
 <https://theupdateframework.github.io/specification/latest/#detailed-client-workflow>`_.
 Updater provides an API to query available targets and to download them in a
@@ -37,7 +37,7 @@
       metadata at "/tuf-repo/" and targets at "/targets/"
     * Local metadata directory "~/tufclient/metadata/" is writable and contains
       a root metadata version for the remote repository
-    * Download directory "~/target-downloads/" is writable
+    * Download directory "~/tufclient/downloads/" is writable
 
 Example::