diff options
| author | Samuele Pedroni <pedronis@lucediurna.net> | 2016-01-12 14:47:33 +0100 |
|---|---|---|
| committer | Samuele Pedroni <pedronis@lucediurna.net> | 2016-01-12 14:47:33 +0100 |
| commit | 42a30068cc9f9cc000d9dd7f08ceff17452fd4ff (patch) | |
| tree | 57a044c4e1cc46d4852028b3df1d27a39876bef5 | |
| parent | c3297ead44e4c7f8e0ef0227d1b3eb304c713002 (diff) | |
declunkify doc comments a little bit
| -rw-r--r-- | asserts/database.go | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/asserts/database.go b/asserts/database.go index 26b282327d..ff9bb8a45e 100644 --- a/asserts/database.go +++ b/asserts/database.go @@ -29,23 +29,23 @@ import ( "time" ) -// Backstore is a backstore for assertions. It can store and retrieve +// A Backstore stores assertions. It can store and retrieve // assertions by type under unique primary key headers. Plus it supports searching by headers. type Backstore interface { // Put stores an assertion for the given primaryKeyHeaders forming a unique key. // It is responsible for checking that assert is newer than a // previously stored revision. Put(assertType AssertionType, primaryKeyHeaders []string, assert Assertion) error - // Get loads the assertion with the given unique key for the primaryKeyHeaders. + // Get returns the assertion with the given unique key for the primaryKeyHeaders. // If none is present it returns ErrNotFound. Get(assertType AssertionType, primaryKeyHeaders, key []string) (Assertion, error) - // Search searches for assertions matching the given headers. + // Search returns assertions matching the given headers. // It invokes foundCb for each found assertion. // As hint the primaryKeyHeaders forming a unique key are also given. Search(assertType AssertionType, primaryKeyHeaders []string, headers map[string]string, foundCb func(Assertion)) error } -// KeypairManager is a manager and backstore for private/public key pairs. +// A KeypairManager is a manager and backstore for private/public key pairs. type KeypairManager interface { // Put stores the given private/public key pair for identity, // making sure it can be later retrieved by authority-id and |
