python-tuf icon indicating copy to clipboard operation
python-tuf copied to clipboard

ngclient: Document internal details (maybe)

Open jku opened this issue 4 years ago • 1 comments

There have been a few suggestions to document ngclient internals (or to publish that documentation):

  • RequestsFetcher
  • TrustedMetadataSet

https://github.com/theupdateframework/python-tuf/issues/1543, https://github.com/theupdateframework/python-tuf/pull/1517#discussion_r694700337

I think we could talk a bit about RequestsFetcher somewhere... either in the Fetcher documentation or Updater docs.

TrustedMetadataSet I would leave as an internal component but make sure it's still well documented. There is a possibility that it's going to be useful as a repository side component as well -- but then it's going to require some changes and can't live in ngclient sources... so I'd rather keep it clearly as an implementation detail

jku avatar Oct 01 '21 12:10 jku

It would be good to document RequestsFetcher as part of the API docs, as that is the default fetcher the updater uses.

For TrustedMetadataSet, I agree it doesn't belong in the API docs. I do think it's neat enough to warrant a blog post, though!

joshuagl avatar Jul 20 '22 13:07 joshuagl