Commits

Matt Chaput committed f2fc3ef

Added documentation for columns module.

  • Participants
  • Parent commits 2430e18

Comments (0)

Files changed (1)

docs/source/api/columns.rst

+=====================
+``columns`` module
+=====================
+
+.. automodule:: whoosh.columns
+
+
+Base classes
+============
+
+.. autoclass:: Column
+    :members:
+
+.. autoclass:: ColumnWriter
+    :members:
+
+.. autoclass:: ColumnReader
+    :members:
+
+
+Basic columns
+=============
+
+.. autoclass:: VarBytesColumn
+
+.. autoclass:: FixedBytesColumn
+
+.. autoclass:: RefBytesColumn
+
+.. autoclass:: NumericColumn
+
+
+Technical columns
+=================
+
+.. autoclass:: BitColumn
+
+.. autoclass:: CompressedBytesColumn
+
+.. autoclass:: StructColumn
+
+.. autoclass:: PickleColumn
+
+.. autoclass:: TranslatingColumn
+
+
+Experimental columns
+====================
+
+.. autoclass:: ClampedNumericColumn
+