Pull Request: Fix “AXT Heading” Typos to “ATX Heading” in Markdown … #2202
Conversation
This file contains 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
…Filters ## Overview ### What’s wrong In the markdown filtering code for **nbconvert**, the standard Markdown headings (commonly referred to as “ATX headings”) were mistakenly spelled as **“AXT.”** This can lead to confusion and errors such as: ``` AttributeError: 'MathBlockParser' object has no attribute 'parse_axt_heading' ``` if something tries to call a method by the wrong name. ### Why it matters - Markdown headings of the form `# Heading` are typically referred to as **ATX headings**. - Maintaining consistent naming is helpful for contributors and future maintainers; it also aligns with official Mistune 2.x/3.x naming conventions. --- ## Proposed Changes ### Rename All Instances of “AXT” to “ATX” In the `MathBlockParser` for Mistune ≥ 3.0, rename: ```diff - AXT_HEADING_WITHOUT_LEADING_SPACES + ATX_HEADING_WITHOUT_LEADING_SPACES ``` ```diff - "axt_heading": AXT_HEADING_WITHOUT_LEADING_SPACES + "atx_heading": ATX_HEADING_WITHOUT_LEADING_SPACES ``` Also, change any internal references accordingly (for example, if there were a `parse_axt_heading` method, rename it to `parse_atx_heading`). --- ### Ensure Backward Compatibility - The change is purely a naming fix, so it should not break existing code or templates, as long as the references within **nbconvert** are updated consistently. - If any external plugins or code rely on the old `axt_heading` name, they might need a minor update, but that’s highly unlikely unless they were already overriding **nbconvert**’s internal parser. ```
|
It looks like #2199 approaches this with more backward compatibility. |
|
Closing in favour of #2199 |
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.
…Filters
Overview
What’s wrong
In the markdown filtering code for nbconvert, the standard Markdown headings (commonly referred to as “ATX headings”) were mistakenly spelled as “AXT.” This can lead to confusion and errors such as:
if something tries to call a method by the wrong name.
Why it matters
# Headingare typically referred to as ATX headings.Proposed Changes
Rename All Instances of “AXT” to “ATX”
In the
MathBlockParserfor Mistune ≥ 3.0, rename:Also, change any internal references accordingly (for example, if there were a
parse_axt_headingmethod, rename it toparse_atx_heading).Ensure Backward Compatibility
axt_headingname, they might need a minor update, but that’s highly unlikely unless they were already overriding nbconvert’s internal parser.