Summary
Several recently landed and in-flight features lack user-facing documentation. This should be addressed before the release candidate.
Missing documentation for landed features
Documentation needed for in-flight PRs
Stale docs
docs/api/functions.md — nearly empty, doesn't list any available functions
docs/schema/joins.md — says "not yet implemented"
Suggested deliverables
- Expression language guide (
docs/api/expressions.md or expand docs/api/functions.md) — document available functions (uuid5, strlen, case, max, min, round, etc.), {slot} null-propagation, collection distribution, and numeric coercion rules
- Multi-output docs — add
-O usage examples to docs/index.md or a dedicated section
- Update
docs/schema/joins.md — remove "not yet implemented", add cross-table lookup examples
- Multiple class_derivation examples — add to index or tutorial
- Update
mkdocs.yml nav if new pages are added
Summary
Several recently landed and in-flight features lack user-facing documentation. This should be addressed before the release candidate.
Missing documentation for landed features
-O/--additional-outputmulti-output CLI option (Add multi-output stream writers and -O CLI option #115) — not documented outside CLI--help. Needs usage examples and explanation of simultaneous multi-format output.uuid5()function (Add uuid5() function to transformation expressions #117) — not listed indocs/api/functions.md(which is currently a ~5-line stub). Needs examples showing deterministic ID generation.class_derivationsfor same target class (Allow multiple class_derivations for the same target class #118) — no examples or explanation of merging behavior. Needs YAML example and use-case guidance.simpleevalexpression engine (Replace hand-rolled expression evaluator with simpleeval #122) — good docstrings ineval_utils.py, but no user-facing expression language guide. Related: Document unrestricted_eval and complex expression support #121.Documentation needed for in-flight PRs
docs/schema/joins.mdstill says "not yet implemented". Needs usage guide with dot-notation lookup examples andsource_schema_patchesintegration.Stale docs
docs/api/functions.md— nearly empty, doesn't list any available functionsdocs/schema/joins.md— says "not yet implemented"Suggested deliverables
docs/api/expressions.mdor expanddocs/api/functions.md) — document available functions (uuid5,strlen,case,max,min,round, etc.),{slot}null-propagation, collection distribution, and numeric coercion rules-Ousage examples todocs/index.mdor a dedicated sectiondocs/schema/joins.md— remove "not yet implemented", add cross-table lookup examplesmkdocs.ymlnav if new pages are added