Rewrite Python package docs and add README validation#328
Open
holodorum wants to merge 4 commits intokson-org:mainfrom
Open
Rewrite Python package docs and add README validation#328holodorum wants to merge 4 commits intokson-org:mainfrom
holodorum wants to merge 4 commits intokson-org:mainfrom
Conversation
The previous README had a broken quick start example (imported non-existent `Success` symbol, called `to_json` without required options arg). Replaced with complete documentation covering all API surfaces: JSON/YAML conversion, formatting, parsing/analysis, schema validation, embed blocks, and error handling. Also fixed pyproject.toml readme path casing for Linux.
holodorum
force-pushed
the
kson-docs-python
branch
from
965185b to
15e06e6
Compare
Runs pytest-codeblocks against readme.md to validate all Python code examples. Included in the check task. Also fixes 3 code blocks that were missing imports or variables needed to run standalone.
Use `val x by register<T>("name")` pattern instead of string constants,
removing the need for top-level name variables.
holodorum
force-pushed
the
kson-docs-python
branch
from
15e06e6 to
2df6ae2
Compare
Collaborator
|
Note that this might conflict with #327 once either of the PRs get merged (because of the krossover update) |
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
2 participants
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
validateReadmeGradle task that runspytest-codeblocksagainst the README to ensure all Python code examples are valid and executableEmbedRulebuild.gradle.ktsto use delegated task registration pattern