Matt Chaput avatar Matt Chaput committed dc819b8

Updated docs TOC for support.bitvector module. Doc updates and fixes.

Comments (0)

Files changed (9)

docs/source/api/codec/base.rst

+=====================
+``codec.base`` module
+=====================
+
+.. automodule:: whoosh.codec.base
+
+
+Classes
+=======
+
+.. autoclass:: Codec
+   :members:
+
+.. autoclass:: PerDocumentWriter
+   :members:
+
+.. autoclass:: FieldWriter
+   :members:
+
+.. autoclass:: TermsReader
+   :members:
+
+.. autoclass:: VectorReader
+   :members:
+
+.. autoclass:: LengthsReader
+   :members:
+
+.. autoclass:: MultiLengths
+   
+.. autoclass:: StoredFieldsReader
+   :members:
+
+.. autoclass:: Segment
+   :members:
+
+
+
+

docs/source/api/query.rst

 .. autoclass:: TermRange
 .. autoclass:: NumericRange
 .. autoclass:: DateRange
-.. autoclass:: Nested
 .. autoclass:: Every
 .. autoclass:: NullQuery
 

docs/source/api/reading.rst

 
 .. autoclass:: MultiReader
 
+.. autoclass:: TermInfo
+   :members:
 
 Exceptions
 ==========

docs/source/api/support/bitvector.rst

 
 .. automodule:: whoosh.support.bitvector
 
-.. autoclass:: BitVector
+
+Base class
+==========
+
+.. autoclass:: DocIdSet
     :members:
 
+
+Implementation classes
+======================
+
+.. autoclass:: BitSet
+.. autoclass:: SortedIntSet
+

docs/source/api/support/dawg.rst

 Graph nodes
 ===========
 
-.. autoclass:: BaseNode
+.. autoclass:: Node
     :members:
 
 .. autoclass:: UnionNode
 .. autoclass:: IntersectionNode
 
 
+Cursor interface
+================
+
+.. autoclass:: BaseCursor
+   :members:
+
+.. autoclass:: Cursor
+
+.. autoclass:: Arc
+   :members:
+
+
+IO classes
+==========
+
+.. autoclass:: GraphWriter
+   :members:
+
+.. autoclass:: BaseGraphReader
+   :members:
+
+.. autoclass:: GraphReader
+
+
 Utility functions
 =================
 
-.. autofunction:: edge_count
-.. autofunction:: flatten
-.. autofunction:: dump_dawg
+.. autofunction:: to_labels
 .. autofunction:: within
 
+
+FST Value classes
+=================
+
+.. autoclass:: Values
+   :members:
+
+.. autoclass:: IntValues
+.. autoclass:: SequenceValues
+.. autoclass:: BytesValues
+.. autoclass:: ArrayValues
+.. autoclass:: IntListValues

docs/source/api/writing.rst

     :members:
 
 
-Posting writer
-==============
-
-.. autoclass:: PostingWriter
-
-
 Exceptions
 ==========
 

src/whoosh/codec/base.py

 # those of the authors and should not be interpreted as representing official
 # policies, either expressed or implied, of Matt Chaput.
 
+"""
+This module contains base classes/interfaces for "codec" objects.
+"""
 
 import random
 from array import array

src/whoosh/query/nested.py

     the :meth:`~whoosh.writing.IndexWriter.group` and/or
     :meth:`~whoosh.writing.IndexWriter.start_group` methods of a
     :class:`whoosh.writing.IndexWriter` to indicate that hierarchically related
-    documents should be kept together:
+    documents should be kept together::
 
         schema = fields.Schema(type=fields.ID, text=fields.TEXT(stored=True))
 
                 w.add_document(type="chap", text="Chapter 3")
                 w.add_document(type="p", text="Fine day")
 
-
     The ``NestedParent`` query wraps two sub-queries: the "parent query"
     matches a class of "parent documents". The "sub query" matches nested
     documents you want to find. For each "sub document" the "sub query" finds,

src/whoosh/support/dawg.py

 # Cursor
 
 class BaseCursor(object):
-    """Base class for cursor objects.
+    """Base class for a cursor-type object for navigating an FST/word graph,
+    represented by a :class:`GraphReader` object.
+    
+    >>> cur = GraphReader(dawgfile).cursor()
+    >>> for key in cur.follow():
+    ...   print(repr(key))
+    
+    The cursor "rests" on arcs in the FSA/FST graph, rather than nodes.
     """
 
     def is_active(self):
 
 
 class Cursor(BaseCursor):
-    """"A cursor-type object for navigating an FST/word graph, represented by a
-    :class:`GraphReader` object.
-    
-    >>> cur = GraphReader(dawgfile).cursor()
-    >>> for key in cur.follow():
-    ...   print(repr(key))
-    
-    The cursor "rests" on arcs in the FSA/FST graph, rather than nodes.
-    """
-
     def __init__(self, graph, root=None, stack=None):
         self.graph = graph
         self.vtype = graph.vtype
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.