[Docs] Adds clarification in user-guide documentation #4256
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
it is not clear or documented anywhere that a local file path is an option as argument to the path parameter. cli _help_ scheme, as well, implies the last argument to be a url (`hint [options] https://url.com`). as only starting to use webhint cli I had this only clarified in a response in the gitter channel
yinonov
requested review from
antross,
molant,
sarvaje and
utsavized
as code owners
yinonov
changed the title
yinonov
commented
Jan 26, 2021
antross
reviewed
Jan 26, 2021
| @@ -26,7 +26,7 @@ best practices that may be applied to your site, complete the following steps. | |||
| uses `npx` to run the `npm` package without installing it. | |||
|
|
|||
| ```bash | |||
| npx hint https://example.com | |||
| npx hint https://example.com // or relative path e.g. './path/to/my.html' | |||
There was a problem hiding this comment.
What do you think about breaking these apart as two complete commands? I think that might help for those that want to copy-paste a local file example with minimal required changes. E.g.
npx hint https://example.comor
npx hint ./path/to/my.htmlThere was a problem hiding this comment.
sure, it's nicer this way
antross
approved these changes
Jan 26, 2021
Removes trailing spaces the linter was complaining about.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
it is not clear or documented anywhere that a local file path is an option as argument to the path parameter.
cli help scheme, as well, implies the last argument to be a url (
hint [options] https://url.com).as only starting to use webhint cli I had this only clarified in a response in the gitter channel
Pull request checklist
Make sure you:
For non-trivial changes, please make sure you also:
Short description of the change(s)