Repository navigation
docs: fix data-model custom tag example and formatter name - #405
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
Add the missing colon to the custom-tag example and correct the formatter method to Model.to_pretty_xml().
This branch has not been deployed
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.
Fix the Data Models guide's custom-tag example and formatter name
Key Changes:
SyntaxError: expected ':'..to_prety_xml()toModel.to_pretty_xml(), which is already used by the adjacent example and exists inrigging/model.py.Added:
Changed:
docs/topics/data-models.mdx(two lines).Removed:
Verification performed on base
3461e81e799aff9040fe0d0671196b78667a7589:SyntaxError; the corrected snippet compiles (compiled only, not executed).rigging/model.pyconfirmsto_pretty_xmlexists andto_prety_xmldoes not.rigging/modules and tests compile syntax-only without importing the package.Not run, and disclosed rather than claimed: the full Ruff/Mypy/pytest CI matrix, pre-commit hooks, and the always-run docs generator. This environment lacks the complete Poetry dependency closure (
poetry install --all-extras) needed for those checks, and the isolatedcodespellmodule is also unavailable. This is a documentation-only change with no runtime source changes.No review requested.