Skip to content

Commit ca6434b

Browse files
jkuLukas Puehringer
authored andcommitted
Metadata API: Improve docstrings
Remove duplicate docstrings: these are already documented in _DelegatorMixin and sphinx will find them there. Tweak a few other strings to remove duplication in the sentence. Signed-off-by: Jussi Kukkonen <jkukkonen@google.com> Metadata API: Improve dosctrings Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
1 parent 0184edc commit ca6434b

1 file changed

Lines changed: 4 additions & 12 deletions

File tree

tuf/api/metadata.py

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ def verify_delegate(
393393
signed_serializer: Optional[SignedSerializer] = None,
394394
) -> None:
395395
"""Verify that ``delegated_metadata`` is signed with the required
396-
threshold of keys for the delegated role ``delegated_role``.
396+
threshold of keys for ``delegated_role``.
397397
398398
.. deprecated:: 2.2.0
399399
Please use ``Root.verify_delegate()`` or ``Targets.verify_delegate()``.
@@ -660,7 +660,7 @@ def verify_delegate(
660660
signed_serializer: Optional[SignedSerializer] = None,
661661
) -> None:
662662
"""Verify that ``delegated_metadata`` is signed with the required
663-
threshold of keys for the delegated role ``delegated_role``.
663+
threshold of keys for ``delegated_role``.
664664
665665
Args:
666666
delegated_role: Name of the delegated role to verify
@@ -859,11 +859,7 @@ def get_delegated_role(self, delegated_role: str) -> Role:
859859

860860
return self.roles[delegated_role]
861861

862-
def get_key(self, keyid: str) -> Key:
863-
"""Return the key object for the given keyid.
864-
865-
Raises ValueError if key is not found.
866-
"""
862+
def get_key(self, keyid: str) -> Key: # noqa: D102
867863
if keyid not in self.keys:
868864
raise ValueError(f"Key {keyid} not found")
869865

@@ -1958,11 +1954,7 @@ def get_delegated_role(self, delegated_role: str) -> Role:
19581954

19591955
return role
19601956

1961-
def get_key(self, keyid: str) -> Key:
1962-
"""Return the key object for the given keyid.
1963-
1964-
Raises ValueError if key is not found.
1965-
"""
1957+
def get_key(self, keyid: str) -> Key: # noqa: D102
19661958
if self.delegations is None:
19671959
raise ValueError("No delegations found")
19681960
if keyid not in self.delegations.keys:

0 commit comments

Comments
 (0)