Skip to content
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

Describe required space after hash as breaking change #4808

Merged
merged 1 commit into from
Aug 4, 2018
Merged

Describe required space after hash as breaking change #4808

merged 1 commit into from
Aug 4, 2018

Conversation

krlmlr
Copy link
Contributor

@krlmlr krlmlr commented Aug 2, 2018

Follow-up to #4801. Happy to update the website too once we agree on the wording.

@jgm
Copy link
Owner

jgm commented Aug 2, 2018

The change is already described in the changelog here:

  * Add `space_in_atx_header` extension (#3512).  This is enabled by default
    in pandoc and GitHub markdown but not the other flavors.
    This requires a space between the opening #'s and the header
    text in ATX headers (as CommonMark does but many other implementations
    do not).  This is desirable to avoid falsely capturing things like

        #hashtag

    or

        #5

@jgm
Copy link
Owner

jgm commented Aug 2, 2018

I don't have objections to adding the proposed text to the changes for the markdown reader, but I wasn't sure if you'd missed the above.

@krlmlr
Copy link
Contributor Author

krlmlr commented Aug 2, 2018

When I noticed the new behavior, I skimmed through the release notes, and looked more carefully at the "Changes in behavior" section for the Markdown reader. I don't know what "ATX" means and missed that item. With the new text there's some redundancy, this feature is described from two different angles. I hope that's not too bad.

@jgm jgm merged commit 5866892 into jgm:master Aug 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants