Skip to content

Formatting Updates #5327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: mkdocs-conversion
Choose a base branch
from
Open

Conversation

daexs
Copy link

@daexs daexs commented Aug 14, 2025

Formatting Updates

daexs added 2 commits August 12, 2025 16:39
Changes were made to line 2037, in the case where a node is valType info_array in the JSON with dimension: 2 (eg. groups in _node.py line 137).
This fixes the issue where markdown interprets it as a hyperlink. This line adds '[][]' to the description after the description passed in the JSON file as part of the validation process.
Now, markdown correctly interprets the brackets as consecutive brackets instead.
All three cases in 'InfoArrayValidator' no longer
encounter '[][]' errors. For examples, see
'_node.py' groups property, '_image.py' zmax property,
'_dimension.py' constraintrange property.

Keep the newline between "...specified as"
and "* ..." to avoid rendering a code block.

Note: Python now raises a SyntaxWarning due to '\['.
@daexs daexs marked this pull request as ready for review August 14, 2025 14:52
@gvwilson gvwilson self-requested a review August 14, 2025 14:52
@gvwilson gvwilson added P1 needed for current cycle fix fixes something broken labels Aug 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix fixes something broken P1 needed for current cycle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants