theupdateframework / theupdateframework/python-tuf
docs: Include the relevant securesystemslib classes in docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 304
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 17
Description
Signer, Signature (and in future maybe most of Key) are really part of the Metadata API but are technically implemented in securesystemslib.
We should either include those in the python-tuf API docs, or create similar docs for securesystemslib and link to those (but we don't want to document the rest of securesystemslib API in the same manner).
The former (including in python-tuf api docs) might be quite simple as plain:
.. autoclass:: securesystemslib.signer.Signature
seems to get us most of the way there...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing python-tuf API documentation and how its autodoc directives are organized. Determine whether including securesystemslib.signer.Signature and related classes there satisfies the Metadata API goal without documenting unrelated securesystemslib APIs. Done means the relevant classes are documented or linked through a focused, agreed approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100