Skip to content

Commit

Permalink
docs: Fix DelegatedRole rendering
Browse files Browse the repository at this point in the history
Improve class DelegatedRole docstring in order to be rendered
correctly in the documentation built with sphinx and autodoc.

Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
  • Loading branch information
sechkova committed Aug 26, 2021
1 parent 21ff492 commit bfb509a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions tuf/api/metadata.py
Expand Up @@ -984,11 +984,12 @@ class DelegatedRole(Role):
"""A container with information about a delegated role.
A delegation can happen in two ways:
- paths is set: delegates targets matching any path pattern in paths
- path_hash_prefixes is set: delegates targets whose target path hash
starts with any of the prefixes in path_hash_prefixes
starts with any of the prefixes in path_hash_prefixes
paths and path_hash_prefixes are mutually exclusive: both cannot be set,
paths and path_hash_prefixes are mutually exclusive: both cannot be set,
at least one of them must be set.
Attributes:
Expand Down

0 comments on commit bfb509a

Please sign in to comment.