Updated docs

whythawk · Dec 12, 2023 · afbaeb8 · afbaeb8
1 parent 41b2606
commit afbaeb8
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -46,7 +46,6 @@ pip-log.txt
 __pycache__/
 .pytest_cache/
 variations/
-data/
 site/
 .ipynb_checkpoints/
 *.ipynb

diff --git a/docs/actions/collate.md b/docs/actions/collate.md
@@ -0,0 +1,3 @@
+::: whyqd.crosswalk.actions.collate
+    options:
+      show_source: false
diff --git a/docs/strategies/crosswalk.md b/docs/strategies/crosswalk.md
@@ -109,10 +109,11 @@ should be self-explanatory. Each has definitions and examples you can review:
 |:-------------------------------------------------- |:---------:|:--------:|:--------:|:---------:|:--------:|
 | [CALCULATE](../actions/calculate.md)               | X         |          |          | [m X,]    |          |
 | [CATEGORISE](../actions/categorise.md)             | X         | X        | [X,]     | X         |          |
+| [COLLATE](../actions/collate.md)                   | X         |          |          | [X, m,]   |          |
 | [DEBLANK](../actions/deblank.md)                   |           |          |          |           |          |
 | [DEDUPE](../actions/dedupe.md)                     |           |          |          |           |          |
 | [DELETE_ROWS](../actions/delete_rows.md)           |           |          |          |           | [X,]     |
-| [NEW](../actions/new.md)                           |           |          | [X]      |           |          |
+| [NEW](../actions/new.md)                           | X         |          | [X]      |           |          |
 | [PIVOT_CATEGORIES](../actions/pivot_categories.md) | X         |          |          | X         | [X,]     |
 | [PIVOT_LONGER](../actions/pivot_longer.md)         | [X, X]    |          |          | [X,]      |          |
 | [RENAME](../actions/rename.md)                     | X         |          |          | [X]       |          |
@@ -129,7 +130,8 @@ Here:
 - `[X, X]` only two terms accepted,
 - `[X,]` accepts any number of terms,
 - `[m X,]` any number of terms, but each term requires a modifier,
-- `[X m X,]` any number of terms, but indicates a relationship between two terms defined by a modifier.
+- `[X m X,]` any number of terms, but indicates a relationship between two terms defined by a modifier,
+- `[X, m,]` any number of terms or modifiers, in any combination.
 
 !!! example
     Modifiers should be self-explanatory, and this calculation script should be easy to read:

diff --git a/docs/tutorials/tutorial1.md b/docs/tutorials/tutorial1.md
@@ -1,12 +1,12 @@
 ---
-title: Tutorial - Aligning multiple sources of local government data to a single schema
+title: Tutorial - Aligning multiple sources of local government data from a many-headed Excel spreadsheet to a single schema
 summary: Data curation includes all the processes and techniques needed for ethical and reproducable data creation, management, transformation and presentation for reuse.
 authors:
   - Gavin Chait
 date: 2023-05-03
 tags: wrangling, crosswalks, curation
 ---
-# Tutorial 1: Aligning multiple sources of local government data to a single schema
+# Tutorial 1: Aligning multiple sources of local government data from a many-headed Excel spreadsheet to a single schema
 
 **whyqd** (/wɪkɪd/) was developed to solve a daily, grinding need. This tutorial is based on a real-world problem.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -54,6 +54,7 @@ nav:
 - Actions API:
   - CALCULATE: actions/calculate.md
   - CATEGORISE: actions/categorise.md
+  - COLLATE: actions/collate.md
   - DEBLANK: actions/deblank.md
   - DEDUPE: actions/dedupe.md
   - DELETE_ROWS: actions/delete_rows.md