★ wanayoo — archive 1999 https://github.com/nodejs/node/pull/28127Nouvelle recherche | Portail wanayoo
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 prohibited-strings warning in pull-requests.md #28127

Merged
merged 1 commit into from Jun 10, 2019

Conversation

rexagod
Copy link
Contributor

@rexagod rexagod commented Jun 7, 2019

corrected "Github" to "GitHub" in compliance
to the linting standards

Checklist

Warn log

$ node tools/lint-md.js -q -f doc/guides/
doc/guides/contributing/pull-requests.md
  87:1-88:19  warning  Use "GitHub" instead of "Github"  prohibited-strings  remark-lint

⚠ 1 warning

Trott
Trott approved these changes Jun 7, 2019
@Trott
Copy link
Member

@Trott Trott commented Jun 7, 2019

Anyone know why that file isn't getting linted with make lint-md? Seems to me like it ought to be. I'm probably not seeing some setting somewhere that disables stuff for the directory or something like that?

@richardlau
Copy link
Member

@richardlau richardlau commented Jun 8, 2019

Anyone know why that file isn't getting linted with make lint-md? Seems to me like it ought to be. I'm probably not seeing some setting somewhere that disables stuff for the directory or something like that?

The ** in

node/Makefile

Line 1162 in 6447be6

LINT_MD_DOC_FILES = $(shell ls doc/*.md doc/**/*.md)
is shell dependent. For bash, for example, the globstar option would need to be set: https://unix.stackexchange.com/questions/62660/the-result-of-ls-ls-and-ls/62665#62665

@richardlau richardlau mentioned this pull request Jun 8, 2019
2 tasks
@richardlau
Copy link
Member

@richardlau richardlau commented Jun 8, 2019

#28128 should fix the Makefile so that it lints all the *.md files under doc including the ones in nested subdirectories like the one being fixed in this PR.

lpinca
lpinca approved these changes Jun 9, 2019
trivikr
trivikr approved these changes Jun 9, 2019
@Trott
Copy link
Member

@Trott Trott commented Jun 10, 2019

Correct "Github" to "GitHub" in compliance
to the linting standards.

PR-URL: nodejs#28127
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@Trott
Copy link
Member

@Trott Trott commented Jun 10, 2019

Landed in 03d008f

@Trott
Copy link
Member

@Trott Trott commented Jun 10, 2019

Thanks for the contribution! 🎉

(If you're interested in other possible contributions to Node.js but don't have a good idea of where to start looking, some ideas are posted at https://www.nodetodo.org/next-steps/.)

@Trott Trott merged commit 03d008f into nodejs:master Jun 10, 2019
1 of 2 checks passed
@rexagod rexagod deleted the doc-lint-1 branch Jun 10, 2019
Trott added a commit to Trott/io.js that referenced this issue Jun 13, 2019
`**` expansion doesn't behave as expected and as a result files in
nested subdirectories under `doc` were not linted. Use `find` instead
to generate the list of files to lint.

PR-URL: nodejs#28128
Refs: nodejs#28127
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
BridgeAR added a commit that referenced this issue Jun 17, 2019
Correct "Github" to "GitHub" in compliance
to the linting standards.

PR-URL: #28127
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
BridgeAR added a commit that referenced this issue Jun 17, 2019
`**` expansion doesn't behave as expected and as a result files in
nested subdirectories under `doc` were not linted. Use `find` instead
to generate the list of files to lint.

PR-URL: #28128
Refs: #28127
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Jun 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

7 participants