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

doc: fix 2 files JSDoc typo #34218

Closed
wants to merge 1 commit into from
Closed

Conversation

KuthorX
Copy link
Contributor

@KuthorX KuthorX commented Jul 6, 2020

fix the following files JSDoc typo

lib/punycode.js
UPDATE

tools/lint-md.js will not be changed by this branch

Checklist

@nodejs-github-bot nodejs-github-bot added the tools Issues and PRs related to the tools directory. label Jul 6, 2020
@KuthorX
Copy link
Contributor Author

KuthorX commented Jul 6, 2020

Besides, I notice that lib/lint-md.js is using different EOF, should they be unified into one format? If not, developer can't directly use VSCode or WebStorm modify this file, because they will unify EOF while saving. Vim will not change.

@Trott
Copy link
Member

Trott commented Jul 6, 2020

lint-md.js is generated so should not be edited. Something should probably be done to the process so that it ends up with the same line and file endings as everything else. The generation routine can be found in the Makefile's lint-md-rollup task. The key bit there is the build-node task in the package.json file in tools/node-lint-md-cli-rollup.

Less sure about punycode.js. It used to be from an upstream source but I think we've modified it and it's no longer maintained upstream. Someone want to confirm that?

@Trott
Copy link
Member

Trott commented Jul 6, 2020

For lint-md.js, you can grep through node_modules dependencies to see where to upstream the fixes. For example, the regxep typo is in the debug module. The repo is here and the typo in that repo is here.

@KuthorX
Copy link
Contributor Author

KuthorX commented Jul 7, 2020

thanks @Trott 's review, I update this branch and push a new branch ( #34233 ) that can add a banner to lint-md.js to hint others don't change this file directly.

@KuthorX
Copy link
Contributor Author

KuthorX commented Sep 5, 2020

Need to be closed since it's not nodejs issue

@KuthorX KuthorX closed this Sep 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants