-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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 linting command for vcbuild #11151
Conversation
Might want to mention that |
Why not add |
@silverwind it seems it's not so simple: #5514 (comment) But sure, it would be a better solution. |
Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM unless someone implements vcbuild lint
.
CONTRIBUTING.md
Outdated
`make lint`/`vcbuild lint`. | ||
`make lint`/`vcbuild jslint`. (At this time, only JavaScript linting is | ||
available on Windows. `make lint` on POSIX will run both JavaScript linting and | ||
C++ linting.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't like how the text between brackets is longer than the text it's supposed to clarify. Maybe it's better just mention lint
and jslint
separately.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps just remove the parens?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, parens removed.
CONTRIBUTING.md
Outdated
`make lint`/`vcbuild lint`. | ||
`make lint`/`vcbuild jslint`. (At this time, only JavaScript linting is | ||
available on Windows. `make lint` on POSIX will run both JavaScript linting and | ||
C++ linting.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps just remove the parens?
Currently, `vcbuild` only supports `jslint`. `vcbuild lint` will not work because there is no `lint` task specified in `vcbuild.bat`. Update documentation to use `vcbuild jslint` instead.
Landed in dccd97d |
Would need backport PRs to land on v4 or v6 |
Currently,
vcbuild
only supportsjslint
.vcbuild lint
will notwork because there is no
lint
task specified invcbuild.bat
. Updatedocumentation to use
vcbuild jslint
instead.Checklist
Affected core subsystem(s)
doc