gibheer
/
bleve
0
0
Fork 0
Code

doc: talk about "documents" not "indexed or stored documents"

This commit is contained in:
Patrick Mezard 2015-10-18 10:56:20 +02:00
parent b174c137fd
commit 2fa334fc27
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
index.go
View File

@ -163,7 +163,7 @@ type Index interface {
// Document returns specified document or nil if the document is not
// indexed or stored.
Document(id string) (*document.Document, error)
// DocCount returns the number of indexed or stored documents.
// DocCount returns the number of documents in the index.
DocCount() (uint64, error)
Search(req *SearchRequest) (*SearchResult, error)

10
index/index.go
View File

@ -47,9 +47,9 @@ type Index interface {
type IndexReader interface {
TermFieldReader(term []byte, field string) (TermFieldReader, error)
// DocIDReader returns an iterator over indexed or stored documents which
// identifiers are greater than or equal to start and smaller than end. The
// caller must close returned instance to release associated resources.
// DocIDReader returns an iterator over documents which identifiers are
// greater than or equal to start and smaller than end. The caller must
// close returned instance to release associated resources.
DocIDReader(start, end string) (DocIDReader, error)
FieldDict(field string) (FieldDict, error)
@ -105,8 +105,8 @@ type FieldDict interface {
Close() error
}
// DocIDReader is the interface exposing enumeration of indexed or stored
// documents identifiers. Close the reader to release associated resources.
// DocIDReader is the interface exposing enumeration of documents identifiers.
// Close the reader to release associated resources.
type DocIDReader interface {
// Next returns the next document identifier in ascending lexicographic
// byte order, or io.EOF when the end of the sequence is reached.