Update docs

CHANGELOG.md

@@ -4,6 +4,7 @@ Change Log
 Unreleased
 ----------
 - Added `timeout` parameter to database initializer (SUHAR1K)
+- Added `final()` method to querysets (M1hacka)
 
 v1.0.3
 ------

docs/class_reference.md

@@ -21,7 +21,7 @@ created on the ClickHouse server if it does not already exist.
 - `username`: optional connection credentials.
 - `password`: optional connection credentials.
 - `readonly`: use a read-only connection.
-- `autocreate`: automatically create the database if does not exist (unless in readonly mode).
+- `autocreate`: automatically create the database if it does not exist (unless in readonly mode).
 - `timeout`: the connection timeout in seconds.
 
 
@@ -866,6 +866,13 @@ Returns a copy of this queryset that includes only rows matching the conditions.
 Add q object to query if it specified.
 
 
+#### final()
+
+
+Adds a FINAL modifier to table, meaning data will be collapsed to final version.
+Can be used with `CollapsingMergeTree` engine only.
+
+
 #### only(*field_names)
 
 
@@ -967,6 +974,13 @@ Returns a copy of this queryset that includes only rows matching the conditions.
 Add q object to query if it specified.
 
 
+#### final()
+
+
+Adds a FINAL modifier to table, meaning data will be collapsed to final version.
+Can be used with `CollapsingMergeTree` engine only.
+
+
 #### group_by(*args)
 
 

docs/toc.md

@@ -25,6 +25,7 @@
       * [Ordering](querysets.md#ordering)
       * [Omitting Fields](querysets.md#omitting-fields)
       * [Distinct](querysets.md#distinct)
+      * [Final](querysets.md#final)
       * [Slicing](querysets.md#slicing)
       * [Pagination](querysets.md#pagination)
       * [Aggregation](querysets.md#aggregation)

src/infi/clickhouse_orm/query.py

@@ -407,7 +407,7 @@ class QuerySet(object):
     def final(self):
         """
         Adds a FINAL modifier to table, meaning data will be collapsed to final version.
-        Can be used with CollapsingMergeTree engine only
+        Can be used with `CollapsingMergeTree` engine only.
         """
         if not isinstance(self._model_cls.engine, CollapsingMergeTree):
             raise TypeError('final() method can be used only with CollapsingMergeTree engine')