Skip to content

docs: fix data-model custom tag example and formatter name - #405

Open
dajiaohuang wants to merge 1 commit into
dreadnode:mainfrom
dajiaohuang:repostew/fix-data-model-docs-20261018
Open

dajiaohuang wants to merge 1 commit into
dreadnode:mainfrom
dajiaohuang:repostew/fix-data-model-docs-20261018

Conversation

@dajiaohuang

Copy link
Copy Markdown

Fix the Data Models guide's custom-tag example and formatter name

Key Changes:

  • Add the missing colon to the custom-tag class example. As written, the documented snippet fails Python compilation with SyntaxError: expected ':'.
  • Correct the instructed formatter method from the nonexistent .to_prety_xml() to Model.to_pretty_xml(), which is already used by the adjacent example and exists in rigging/model.py.

Added:

  • None.

Changed:

  • docs/topics/data-models.mdx (two lines).

Removed:

  • None.

Verification performed on base 3461e81e799aff9040fe0d0671196b78667a7589:

  • The original documented custom-tag snippet reproduces the SyntaxError; the corrected snippet compiles (compiled only, not executed).
  • AST inspection of rigging/model.py confirms to_pretty_xml exists and to_prety_xml does not.
  • Final diff review confirms exactly these two lines changed; selected 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 isolated codespell module is also unavailable. This is a documentation-only change with no runtime source changes.

No review requested.

Add the missing colon to the custom-tag example and correct the formatter method to Model.to_pretty_xml().
@dajiaohuang
dajiaohuang requested a review from a team as a code owner October 18, 2026 12:07
@dreadnode-renovate-bot dreadnode-renovate-bot Bot added area/docs Changes to documentation and guides type/docs Documentation updates and improvements labels Oct 18, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Changes to documentation and guides type/docs Documentation updates and improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant