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

Changelog markdown formatting issue for v16.3.0 (React Test Renderer) #17481

Closed
dance2die opened this issue Nov 28, 2019 · 2 comments · Fixed by #17487

Comments

@dance2die
Copy link
Contributor

@dance2die dance2die commented Nov 28, 2019

React Changelog Markdown documentation formatting issue.

Do you want to request a feature or report a bug?

A bug in formatting, where subtitle should be h3 (with ###) but is marked with h2 (##).

What is the current behavior?

React Test Renderer subtitle is rendered as h2, not h3.

demo

Finding the formatting error

Using Chrome Devtools

  1. Go to https://github.com/facebook/react/blob/master/CHANGELOG.md#react-test-renderer-3
  2. Open Devtools to inspect the HTML.

Via markdown source

  1. Go to https://raw.githubusercontent.com/facebook/react/master/CHANGELOG.md
  2. Search for word * Fix handling of fragments in toTree().
  3. You will see ## React Test Renderer.
    • This should be ### React Test Renderer

search

What is the expected behavior?

React Test Renderer subtitle is rendered as h3 with ###, not as h2 with ## .

Which versions of React, and which browser / OS are affected by this issue? Did this work in previous versions of React?

Not Applicable.

Additional context

It might look like nitpicking but I was programmatically parsing the changelog but ran into the inconsistency.

Hopefully this can be fixed because

  1. It's easy to fix
  2. To prep for automated changelog documentation (for the future possibly).
  3. and for consistency

Demo Sandbox: https://codesandbox.io/s/parse-react-changelog-mjpkg

I can do a PR should you approve

inconsistency

@threepointone

This comment has been minimized.

Copy link
Contributor

@threepointone threepointone commented Nov 28, 2019

Happy to accept a PR for this, but you should be careful because this may break in the future again.

dance2die added a commit to dance2die/react that referenced this issue Nov 28, 2019
@dance2die

This comment has been minimized.

Copy link
Contributor Author

@dance2die dance2die commented Nov 28, 2019

Thank you for the review, @threepointone~
& PR => #17487

you should be careful because this may break in the future again.

I will monitor the changelog just in case as it's created manually.

threepointone added a commit that referenced this issue Nov 29, 2019
trueadm added a commit to trueadm/react that referenced this issue Dec 4, 2019
trueadm added a commit to trueadm/react that referenced this issue Dec 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.