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

Document --tidy-mark flag in tidy --help #1109

Open
mnemnion opened this issue Apr 12, 2024 · 2 comments
Open

Document --tidy-mark flag in tidy --help #1109

mnemnion opened this issue Apr 12, 2024 · 2 comments

Comments

@mnemnion
Copy link

I have no objection to your choice to insert <meta name="generator"... into tidied files. It's questionable whether what tidy does is "generation", but including a slug naming your software as a default is reasonable.

I do think you should document the --tidy-mark flag under processing directives.

Something like this:

--tidy-mark yes|no    omit or produce a meta tag indicating the use of tidy. Defaults to yes.

I would also argue that --quiet should include --tidy-mark no. It definitely meets the criteria for "nonessential output".

But documenting that it's possible to remove this would be the bare minimum. All your program is doing in my pipeline is indentation, and calling that "generation" is inappropriate.

@ler762
Copy link
Contributor

ler762 commented Apr 13, 2024 via email

@chrispy-snps
Copy link

I agree with both suggested changes (document the option in the usage, and replace all Unicode-encoded hyphens with simple ASCII hyphens in the man page).

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

No branches or pull requests

3 participants