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: clean up .js-with-links #6459

Merged
merged 3 commits into from
Oct 19, 2022

Conversation

chenxsan
Copy link
Member

@chenxsan chenxsan commented Oct 18, 2022

We have this .js-with-links from remark-refractor which would generates links inside code block.

Unfortunately it's totally broken at the moment:

I have no idea when and how we broke it, and I have no interest to fix it for two reasons:

  1. it's hard to maintain.

  2. Editors like VSCode won't apply syntax highlighting to such a code block, which means we are on our own when editing the code block.

Hence I would like to take this opportunity to clean up them.

@vercel
Copy link

vercel bot commented Oct 18, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
webpack-js-org ✅ Ready (Inspect) Visit Preview Oct 19, 2022 at 4:49AM (UTC)

if (err || stats.hasErrors()) {
// [Handle errors here](#error-handling)
//
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
//

Copy link
Contributor

Choose a reason for hiding this comment

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

Just wondering if these empty comments were intentional

Copy link
Member Author

Choose a reason for hiding this comment

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

It's a placeholder, guess it makes more sense to use // ....

snitin315
snitin315 previously approved these changes Oct 19, 2022
Copy link
Member

@snitin315 snitin315 left a comment

Choose a reason for hiding this comment

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

Makes sense to move away from this 👍🏻

@chenxsan chenxsan merged commit b19c946 into webpack:master Oct 19, 2022
@chenxsan chenxsan deleted the bugfix/cleanup-js-with-links branch October 19, 2022 04:57
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.

3 participants