shithub: furgit

Info  •  Files  •  Log  •  Branches

refstore: Add documentation on declared Store methods

--- a/refstore/refstore.go

+++ b/refstore/refstore.go

@@ -12,8 +12,20 @@

 // Store reads Git references.

 type Store interface {

+	// Resolve resolves a reference name to either a symbolic or detached ref.

+	// If the reference does not exist, implementations should return

+	// ErrReferenceNotFound.

 	Resolve(name string) (ref.Ref, error)

+	// ResolveFully resolves a reference name to a detached object ID.

+	//

+	// Implementations may use backend-local lookup semantics for symbolic hops.

+	// Callers that need cross-backend symbolic resolution (for example in a

+	// chain of stores) should prefer repeatedly calling Resolve.

 	ResolveFully(name string) (ref.Detached, error)

+	// List returns references matching pattern.

+	//

+	// The exact pattern language is backend-defined.

 	List(pattern string) ([]ref.Ref, error)

+	// Close releases resources associated with the store.

 	Close() error

 }

-- 

⑨