Skip to content

Add proof:kind spelling for proof directives and ref role#2983

Merged
choldgraf merged 2 commits into
jupyter-book:mainfrom
stefanv:proof-directive-alias
Jul 3, 2026
Merged

Add proof:kind spelling for proof directives and ref role#2983
choldgraf merged 2 commits into
jupyter-book:mainfrom
stefanv:proof-directive-alias

Conversation

@stefanv

@stefanv stefanv commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Adds proof:kind (e.g. {proof:theorem}) and {proof:ref} as the recommended spellings, generated alongside the legacy prf:kind/prf:ref aliases so existing content keeps building. Docs now only show the proof: forms.

@changeset-bot

changeset-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 6cccac1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
myst-ext-proof Patch
myst-roles Patch
myst-parser Patch
myst-directives Patch
myst-to-html Patch
myst-transforms Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@stefanv

stefanv commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator Author

After merging, update myst-theme example docs (like color picker) to use proof instead of prf.

Adds `proof:kind` (e.g. `{proof:theorem}`) and `{proof:ref}` as the
recommended spellings, generated alongside the legacy `prf:kind`/`prf:ref`
aliases so existing content keeps building. Docs now only show the
`proof:` forms.
@stefanv stefanv force-pushed the proof-directive-alias branch from d20cea9 to 68c2669 Compare July 1, 2026 20:56

@rowanc1 rowanc1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice - code review looks good to go.

This makes a bunch more sense, and is backwards compatible with sphinx-proof as well, which is where this came from.

@stefanv stefanv added the maintenance Refactoring or maintenance of a code or function label Jul 1, 2026

@choldgraf choldgraf left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think proof is pretty short, and more precise, so I'm +1 on this! Given that @rowanc1 already approved as well, I'll merge! :-)

@choldgraf choldgraf merged commit 403caed into jupyter-book:main Jul 3, 2026
6 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Refactoring or maintenance of a code or function

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants