Open mnemnion opened 4 months ago
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.
On my system a 'man tidy' has this bit:
‐‐tidy‐mark Boolean (yes if unset)
This option specifies if Tidy should add a meta element to
the document head to indicate that the document has been tidied.
Tidy won’t add a meta element if one is already present.
Message ID: @.***>
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).
I have no objection to your choice to insert
<meta name="generator"...
into tidied files. It's questionable whether whattidy
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:
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.