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

[docs] Fix Markdown syntax typo in Webpack docs. #5280

Merged
merged 1 commit into from
Jan 11, 2018

Conversation

jessestuart
Copy link
Contributor

@jessestuart jessestuart commented Jan 11, 2018

Summary
A un-escaped reference to <rootDir> in a blockquote was being interpreted as an HTML tag, causing it not to appear in the rendered docs — the result of which is a slightly confusing read. This PR surrounds the tag in backticks to ensure it's rendered correctly. (See screenshots below)

Test plan

I've verified this fix by running the docs website locally, e.g.:

$ yarn && yarn build
$ cd website && yarn start # Verify regression exists in `master` (see screenshot #1)
$ cd -
$ nvim docs/Webpack.md  # Fix typo
$ cd website && yarn start # Verify regression is fixed (see screenshot #2)

Screenshot #1

image

Screenshot #2

image

@codecov-io
Copy link

Codecov Report

Merging #5280 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5280   +/-   ##
=======================================
  Coverage   60.98%   60.98%           
=======================================
  Files         203      203           
  Lines        6816     6816           
  Branches        3        4    +1     
=======================================
  Hits         4157     4157           
  Misses       2658     2658           
  Partials        1        1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5956891...a039f94. Read the comment docs.

@SimenB SimenB merged commit 239f1ec into jestjs:master Jan 11, 2018
@jessestuart jessestuart deleted the docs/fix_webpack_markdown_typo branch January 11, 2018 09:43
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants