docs for v0.4.6

endremborza · Mar 28, 2023 · 19a6be7 · 19a6be7
1 parent 1cdcbb3
commit 19a6be7
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 0 deletions.
diff --git a/docs/api/parquetranger.DfBatchWriter.rst b/docs/api/parquetranger.DfBatchWriter.rst
@@ -0,0 +1,7 @@
+DfBatchWriter
+=============
+
+.. currentmodule:: parquetranger
+
+.. autoclass:: DfBatchWriter
+   :show-inheritance:
diff --git a/docs/api/parquetranger.RecordWriter.rst b/docs/api/parquetranger.RecordWriter.rst
@@ -0,0 +1,29 @@
+RecordWriter
+============
+
+.. currentmodule:: parquetranger
+
+.. autoclass:: RecordWriter
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~RecordWriter.record_limit
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~RecordWriter.add_to_batch
+      ~RecordWriter.writer_function
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: record_limit
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: add_to_batch
+   .. automethod:: writer_function
diff --git a/docs/api/parquetranger.TableRepo.rst b/docs/api/parquetranger.TableRepo.rst
@@ -24,8 +24,12 @@ TableRepo
       ~TableRepo.batch_extend
       ~TableRepo.env_ctx
       ~TableRepo.extend
+      ~TableRepo.get_extending_df_batch_writer
+      ~TableRepo.get_extending_dict_batch_writer
       ~TableRepo.get_full_df
       ~TableRepo.get_partition_paths
+      ~TableRepo.get_replacing_df_batch_writer
+      ~TableRepo.get_replacing_dict_batch_writer
       ~TableRepo.map_partitions
       ~TableRepo.purge
       ~TableRepo.read_df_from_path
@@ -49,8 +53,12 @@ TableRepo
    .. automethod:: batch_extend
    .. automethod:: env_ctx
    .. automethod:: extend
+   .. automethod:: get_extending_df_batch_writer
+   .. automethod:: get_extending_dict_batch_writer
    .. automethod:: get_full_df
    .. automethod:: get_partition_paths
+   .. automethod:: get_replacing_df_batch_writer
+   .. automethod:: get_replacing_dict_batch_writer
    .. automethod:: map_partitions
    .. automethod:: purge
    .. automethod:: read_df_from_path

diff --git a/docs/release_notes/v0.4.6.rst b/docs/release_notes/v0.4.6.rst
@@ -0,0 +1,4 @@
+v0.4.6
+---------------------
+
+add batch writers