search

WICG / shape-detection-api

Detection of shapes (faces, QR codes) in images
https://wicg.github.io/shape-detection-api
Other
306 stars 36 forks source link

Spec source file uses "section autolinks" incorrectly, they'll start breaking #84

Closed tabatkins closed 4 years ago

tabatkins commented 4 years ago

The .bs source uses section autolinks ([[spec#heading-id]]) for a lot of places where it intends to just link to definitions in those specs. This is incorrect markup; if the specs' heading data isn't in Bikeshed, Bikeshed just throws up its hands and assumes you know what you're linking to. (Which means that the links are fragile/unsafe, with no guarantee that the ID exists at all in the destination document.)

However, these specs were in Bikeshed, I just wasn't processing the spec names properly; now that I've fixed that, Bikeshed is (correctly) reporting that those IDs don't correspond to any headings in the spec, and no longer generating a link. The next time you (or your CI) generates the spec, you'll get a number of fatal errors, and the output will lose several links.

Please replace these with proper autolinks, such as [=term here=] or {{Foo/method()}}: see https://tabatkins.github.io/bikeshed/#autolink-microsyntax for guidance on syntax, or feel free to contact me in IRC at Freenode#whatwg or W3C#css.

reillyeon commented 4 years ago

Has this change been pushed to Bikeshed? I just pulled master, ran bikeshed update and don't see any new errors.

tabatkins commented 4 years ago

Not quite yet - I was filing the issues before I pushed the changes, and then it was time to catch the bus. ^_^ I'll be pushed in a few.

tabatkins commented 4 years ago

and done