Improve docstrings in Metadata API to be more descriptive #1843
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 2005290094
💛 - Coveralls |
ivanayov
changed the title
lukpueh
reviewed
Mar 16, 2022
There was a problem hiding this comment.
Thanks for the updates, @ivanayov! I am unsure if the "dict -> json/dict" changes really add much clarification, but I don't object.
I do have an alternative suggestion for the Signer docstring though. Let me know what you think.
|
Thank you @lukpueh , I updated with your proposal. |
ivanayov
force-pushed
the
metadata_docstrings_imprv_follow_up
branch
from
9a5cbfd
to
4069c95
Compare
This change updates some parts of the Metadata API docstrings that did not give enough details and context Fixes theupdateframework#1600 Signed-off-by: Ivana Atanasova <[email protected]>
Change to @lukpueh proposal with more clarification on why and how the `securesystemslib.signer.Signer` interface is used Co-authored-by: Lukas Pühringer <[email protected]> Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov
force-pushed
the
metadata_docstrings_imprv_follow_up
branch
from
4069c95
to
e71aa4a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change updates some parts of the Metadata API docstrings
that did not give enough details and context
Fixes #1600