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

Update the help for --enable & --disable #315

Merged
merged 4 commits into from Aug 16, 2022
Merged

Update the help for --enable & --disable #315

merged 4 commits into from Aug 16, 2022

Conversation

MFTabriz
Copy link
Contributor

to reflect 33f319c

@MFTabriz MFTabriz changed the title Update the help for –enable & --disable Update the help for --enable & --disable Aug 16, 2022
@DavidAnson
Copy link
Collaborator

I considered this when I made the related change, but did not do it because I feel like it clutters up the list of options. I felt like that list should be more about what the options are instead of general syntax. For example, the two dashes are not needed when the list is the final parameter. I don't feel very strongly about this, but as it's only come up once so far I figured that calling it out in the README would be sufficient.

@MFTabriz
Copy link
Contributor Author

For example, the two dashes are not needed when the list is the final parameter.

You are right! But the usage guide (Usage: markdownlint [options] <files|directories|globs>) explicitly tells people to put the options before the files but it clearly does not work that way. Maybe I’m too lazy but --help is usually the first (and sometimes the only) place I look for the basic usage guide.

@DavidAnson
Copy link
Collaborator

What about just showing the two dashes in the example like you have but not adding the text talking about them?

show -- only in the example
show -- only in the example
@MFTabriz
Copy link
Contributor Author

What about just showing the two dashes in the example like you have but not adding the text talking about them?

Yes. This can give users a hint on how to use those options properly. I updated the files.

@DavidAnson
Copy link
Collaborator

Thanks!

@DavidAnson DavidAnson merged commit dd95e43 into igorshubovych:master Aug 16, 2022
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.

None yet

2 participants