Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

metadata API: add missing arguments docs #1599

Closed
jku opened this issue Oct 1, 2021 · 0 comments · Fixed by #1620
Closed

metadata API: add missing arguments docs #1599

jku opened this issue Oct 1, 2021 · 0 comments · Fixed by #1620
Labels
backlog Issues to address with priority for current development goals documentation Documentation of the project as well as procedural documentation

Comments

@jku
Copy link
Member

jku commented Oct 1, 2021 •
edited
Loading

We're missing method argument docs in the docstrings for

Root.add_key()
Root.remove_key()
Targets.add_key()
Targets.remove_key()
DelegatedRole.is_delegated_path()
Key.from_securesystemslib_key()

https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html

we should have (preferably one-liner) descriptions for each argument
@jku jku added the documentation Documentation of the project as well as procedural documentation label Oct 1, 2021
@jku jku mentioned this issue Oct 1, 2021
Merged
@jku jku changed the title metadata API: document add_key/remove_key arguments metadata API: add missing arguments docs Oct 1, 2021
@jku jku mentioned this issue Oct 1, 2021
Closed
4 tasks
@jku jku added the backlog Issues to address with priority for current development goals label Oct 13, 2021
@lukpueh lukpueh mentioned this issue Oct 14, 2021
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backlog Issues to address with priority for current development goals documentation Documentation of the project as well as procedural documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add missing method args docs in metadata API lukpueh/tuf
1 participant
@jku