Docs/codegen update

techascent · Oct 9, 2023 · 8b9f359 · 8b9f359
1 parent 53e21b0
commit 8b9f359
Show file tree

Hide file tree

Showing 36 changed files with 171 additions and 159 deletions.
diff --git a/docs/000-getting-started.html b/docs/000-getting-started.html
diff --git a/docs/100-walkthrough.html b/docs/100-walkthrough.html
diff --git a/docs/200-quick-reference.html b/docs/200-quick-reference.html
diff --git a/docs/columns-readers-and-datatypes.html b/docs/columns-readers-and-datatypes.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/nippy-serialization-rocks.html b/docs/nippy-serialization-rocks.html
diff --git a/docs/supported-datatypes.html b/docs/supported-datatypes.html
diff --git a/docs/tech.v3.dataset.categorical.html b/docs/tech.v3.dataset.categorical.html
diff --git a/docs/tech.v3.dataset.clipboard.html b/docs/tech.v3.dataset.clipboard.html
diff --git a/docs/tech.v3.dataset.column-filters.html b/docs/tech.v3.dataset.column-filters.html
diff --git a/docs/tech.v3.dataset.column.html b/docs/tech.v3.dataset.column.html
diff --git a/docs/tech.v3.dataset.html b/docs/tech.v3.dataset.html
diff --git a/docs/tech.v3.dataset.io.csv.html b/docs/tech.v3.dataset.io.csv.html
diff --git a/docs/tech.v3.dataset.io.datetime.html b/docs/tech.v3.dataset.io.datetime.html
diff --git a/docs/tech.v3.dataset.io.string-row-parser.html b/docs/tech.v3.dataset.io.string-row-parser.html
diff --git a/docs/tech.v3.dataset.io.univocity.html b/docs/tech.v3.dataset.io.univocity.html
diff --git a/docs/tech.v3.dataset.join.html b/docs/tech.v3.dataset.join.html
diff --git a/docs/tech.v3.dataset.math.html b/docs/tech.v3.dataset.math.html
diff --git a/docs/tech.v3.dataset.metamorph.html b/docs/tech.v3.dataset.metamorph.html
diff --git a/docs/tech.v3.dataset.modelling.html b/docs/tech.v3.dataset.modelling.html
diff --git a/docs/tech.v3.dataset.neanderthal.html b/docs/tech.v3.dataset.neanderthal.html
diff --git a/docs/tech.v3.dataset.print.html b/docs/tech.v3.dataset.print.html
diff --git a/docs/tech.v3.dataset.reductions.apache-data-sketch.html b/docs/tech.v3.dataset.reductions.apache-data-sketch.html
diff --git a/docs/tech.v3.dataset.reductions.html b/docs/tech.v3.dataset.reductions.html
diff --git a/docs/tech.v3.dataset.rolling.html b/docs/tech.v3.dataset.rolling.html
diff --git a/docs/tech.v3.dataset.set.html b/docs/tech.v3.dataset.set.html
diff --git a/docs/tech.v3.dataset.tensor.html b/docs/tech.v3.dataset.tensor.html
diff --git a/docs/tech.v3.dataset.zip.html b/docs/tech.v3.dataset.zip.html
diff --git a/docs/tech.v3.libs.arrow.html b/docs/tech.v3.libs.arrow.html
diff --git a/docs/tech.v3.libs.fastexcel.html b/docs/tech.v3.libs.fastexcel.html
diff --git a/docs/tech.v3.libs.guava.cache.html b/docs/tech.v3.libs.guava.cache.html
diff --git a/docs/tech.v3.libs.parquet.html b/docs/tech.v3.libs.parquet.html
diff --git a/docs/tech.v3.libs.poi.html b/docs/tech.v3.libs.poi.html
diff --git a/docs/tech.v3.libs.smile.data.html b/docs/tech.v3.libs.smile.data.html
diff --git a/docs/tech.v3.libs.tribuo.html b/docs/tech.v3.libs.tribuo.html
diff --git a/src/tech/v3/dataset/metamorph.clj b/src/tech/v3/dataset/metamorph.clj
@@ -489,8 +489,10 @@ null [6 3]:
 
 
 (defn group-by
-  "Produce a map of key-fn-value->dataset.  key-fn is a function taking
-  a map of colname->column-value.
+  "Produce a map of key-fn-value->dataset.  The argument to key-fn 
+  is a map of colname->column-value representing a row in dataset.
+  Each dataset in the resulting map contains all and only rows 
+  that produce the same key-fn-value.
 
   Options - options are passed into dtype arggroup:
 
@@ -513,7 +515,9 @@ null [6 3]:
 
 
 (defn group-by-column
-  "Return a map of column-value->dataset.
+  "Return a map of column-value->dataset.  Each dataset in the
+  resulting map contains all and only rows with the same value in
+  column.
 
   * `:group-by-finalizer` - when provided this is run on each dataset immediately after the
      rows are selected.  This can be used to immediately perform a reduction on each new