Repository navigation
docs: expand executable notebook coverage - #2163
Merged
Merged
Conversation
lmeyerov
changed the title
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.
Add an executable GFQL indexing notebook with a local account-and-transfer graph, linked from the indexing guide and performance navigation. Its pip and uv instructions install the latest released Graphistry package.
Expand the regular
test-docsnotebook execution list from three to six notebooks. CI now executes the new indexing notebook and the existing GFQL validation and static rendering tutorials against the PR's editable package.Repair the validation tutorial's obsolete
validate_schema=Trueargument. Its missing-column examples now selectstrict=True, matching the promised errors under current openCypher defaults. Assertions check valid query results and expected validation errors.Validation: all 21 indexing code cells passed on pandas and Polars; all 13 validation cells and eight static rendering cells passed locally through the CI nbconvert command. Rendering produced four SVGs with the expected five nodes and five edges, plus DOT and Mermaid output. Shell syntax, notebook format and diff checks passed. Remote docs CI passed on 82289aa; its log confirms all six notebooks executed successfully. All applicable PR checks, including Read the Docs, passed.