Fix documentation discrepancies with actual code implementation#20
Merged
Fix documentation discrepancies with actual code implementation#20
Conversation
- Fix 3 broken links to non-existent sql-queries.qmd (now query.qmd) - Fix CLI query command syntax: positional SQL arg, not --sql option - Add missing CLI commands: migrator, lsp, preagg (recommend/apply/refresh) - Add missing CLI options to workbench/serve (--connection, --db) - Fix python-api.qmd: remove non-existent offset from query(), parameters from sql() - Document all compile() parameters (order_by, limit, offset, dialect, use_preaggregations) - Add many_to_many relationship type to all relevant docs - Add deprecation notices for Parameter class with migration guidance - Add Segments section to YAML_FORMAT.md - Add Pre-aggregations section to YAML_FORMAT.md - Document dimension hierarchies (parent property) - Add missing time comparison types (dod, prior_period) - Note foreign_key defaults for many_to_one relationships - Add Measure backwards-compatibility alias note
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive documentation audit and fix to align docs with actual code implementation. Addresses user complaints about documentation divergence.
sql-queries.qmd(nowquery.qmd)querycommand syntax: positional SQL arg, not--sqloptionmigrator,lsp,preagg(with subcommands)workbench/serve(--connection,--db)python-api.qmd: remove non-existentoffsetfromquery(),parametersfromsql()compile()parametersmany_to_manyrelationship type to all relevant docsParameterclass with migration guidanceYAML_FORMAT.mdYAML_FORMAT.mdparentproperty)dod,prior_period)foreign_keydefaults formany_to_onerelationshipsMeasurebackwards-compatibility alias noteReview reports generated in
docs/_review/(not committed) provide detailed audit trails.