Repository navigation
docs: make the quoted-name examples runnable - #143
Merged
Merged
Conversation
The quoted-name examples in the Cypher and SQL guides queried a `Device Type` label that the engine on those pages doesn't have, so running either page top to bottom failed there. Each example now builds a small engine with that label. Also point the local spell check at typos 1.51.1, the version CI runs since #141.
Deploying lance-csr with
|
| Latest commit: |
459ee03
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://bd16d876.lance-csr.pages.dev |
| Branch Preview URL: | https://docs-runnable-quoted-name-ex.lance-csr.pages.dev |
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
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.
Why
The quoted-name examples in the Cypher and SQL guides query a
Device Typelabel, but the engine set up earlier on each page has no such label. A reader running either page top to bottom gets aValueErrorat that example, anddocs/check_snippets.pyreports both blocks as failing onmain. They came in with quoted identifiers in #121. CI doesn't run the snippet check, which is how they got through.Separately, #141 moved Spell Check to typos 1.51.1, while the contributor instructions still say to run 1.26.0 locally.
What changed
Device Typenode table keyed byasset id, under names that don't shadow the page'sengine,configorgraph. The SQL example also shows its result, as the Cypher one does.Validation
docs/check_snippets.pypasses on every page; onmain,cypher.mdandsql.mdeach had one failing block.zensical build --strictandtypos1.51.1 pass locally. CI is pending.🤖 Generated with Claude Code