Skip to content

Commit fd02226

Browse files
committed
repository: Improve dosctrings
Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
1 parent 48865ae commit fd02226

2 files changed

Lines changed: 4 additions & 7 deletions

File tree

examples/repository/_simplerepo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class SimpleRepository(Repository):
4343
4444
Attributes:
4545
role_cache: Every historical metadata version of every role in this
46-
repositorys. Keys are role names and values are lists of Metadata
46+
repository. Keys are role names and values are lists of Metadata
4747
signer_cache: All signers available to the repository. Keys are role
4848
names, values are lists of signers
4949
target_cache: All target files served by the repository. Keys are

tuf/repository/_repository.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class Repository(ABC):
2828
application, whether it is a real repository server or a developer tool.
2929
3030
Implementations must implement open() and close(), and can then use the
31-
edit() contextmanager to implement actual operations. Not that signing
31+
edit() contextmanager to implement actual operations. Note that signing
3232
an already existing version of metadata (as could be done for threshold
3333
signing) does not fit into this model of open()+close() or edit().
3434
@@ -47,11 +47,8 @@ def open(self, role: str) -> Metadata:
4747
def close(self, role: str, md: Metadata) -> None:
4848
"""Write roles metadata into storage
4949
50-
If sign_only, then just append signatures of all available keys.
51-
52-
If not sign_only, update expiry and version and replace signatures
53-
with ones from all available keys. Keep snapshot_info and targets_infos
54-
updated."""
50+
Update expiry and version and replace signatures with ones from all
51+
available keys. Keep snapshot_info and targets_infos updated."""
5552
raise NotImplementedError
5653

5754
@property

0 commit comments

Comments
 (0)