Docs/overhaul - #24
Merged
Merged
Conversation
Closes a discoverability gap, not a code bug (#20): the default sort_mapper resolves fields statically, which can't reach a column that only exists on a per-request CTE. context.order_by() already supports any SQLAlchemy column-like object; this just shows the custom-sorter + extra_context pattern to get there.
- Fix dead Sphinx cross-references in tutorials.rst/filters.rst (labels that never existed - dao, models, router, schema, adapter). - Fix broken code samples in query.rst: strategy_factory.register() doesn't exist (register_strategy), a stray quote made 'case _" :' a syntax error, and the second query-strategy example still used the pre-0.4.0 raw Query/get_query() -> Query shape, contradicting the QueryContext section a few paragraphs below it in the same file. - Update basics.rst's DAO section, which was written as if SQLAlchemy is the only possible backend and never got a 0.4.0 pass. - Split README examples that showed two sequential 'return' statements in one function (the second unreachable) into separate snippets. - Fix dozens of typos and tighten grammar throughout; reduce emoji and align tone with the 0.4.0-era additions (query.rst escape hatches, sorter.rst CTE section, CHANGELOG.md) so the doc set reads as one voice instead of two. - Verified with a real Sphinx build (-W --keep-going -n): zero cross-reference/label warnings, only the pre-existing, unrelated missing _static path warning remains.
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.
No description provided.