W3C home > Mailing lists > Public > public-webrtc@w3.org > September 2022

[mediacapture-screen-share] Inconsistent formatting in doc (#234)

From: Elad Alon via GitHub <sysbot+gh@w3.org>
Date: Thu, 29 Sep 2022 12:11:02 +0000
To: public-webrtc@w3.org
Message-ID: <issues.opened-1390764087-1664453461-sysbot+gh@w3.org>
eladalon1983 has just created a new issue for https://github.com/w3c/mediacapture-screen-share:

== Inconsistent formatting in doc ==
The document is very inconsistently formatted. It appears to have been done by hand, or rather, by many different hands.

The README for this repo claims:
> #### To Reflow the Spec
> To format the draft use something like
> tidy --quiet y -utf8 --vertical-space y --tidy-mark n -indent -wrap 80


Presumably "something like" is a key part of that instruction, since the actual command proposed does not work anymore:
```
$ tidy --quiet y -utf8 --vertical-space y --tidy-mark n -indent -wrap 80 index.html
line 13 column 5 - Error: <section> is not recognized!
line 13 column 5 - Warning: discarding unexpected <section>
line 19 column 5 - Warning: discarding unexpected </section>
line 20 column 5 - Error: <section> is not recognized!
line 20 column 5 - Warning: discarding unexpected <section>
line 25 column 5 - Warning: discarding unexpected </section>
line 26 column 5 - Error: <section> is not recognized!
line 26 column 5 - Warning: discarding unexpected <section>
line 49 column 5 - Warning: discarding unexpected </section>
line 50 column 5 - Error: <section> is not recognized!
line 50 column 5 - Warning: discarding unexpected <section>
line 62 column 5 - Warning: discarding unexpected </section>
line 63 column 5 - Error: <section> is not recognized!
line 63 column 5 - Warning: discarding unexpected <section>
line 77 column 5 - Warning: discarding unexpected </section>
line 78 column 5 - Error: <section> is not recognized!
```

I think we should have an exact automatic-formatter command and start using it when merging PRs.

Please view or discuss this issue at https://github.com/w3c/mediacapture-screen-share/issues/234 using your GitHub account


-- 
Sent via github-notify-ml as configured in https://github.com/w3c/github-notify-ml-config
Received on Thursday, 29 September 2022 12:11:04 UTC

This archive was generated by hypermail 2.4.0 : Friday, 3 March 2023 08:55:24 UTC