OFFICIAL BREAKING-CHANGES NOTIFICATION THREAD

[tabatkins]

This is the official announcement thread for breaking changes. If you'd like to be informed about breaking changes, subscribe to this thread.

[tabatkins]

And... Bikeshed is now a Python 3 project. It'll now print out a nice refusal message if you try to run it on Py2.

Install instructions forthcoming, but the most relevant bit is that it requires Python 3.7; this isn't the default py3 install on many OSes, so I recommend using pyenv to install it. Here's a tutorial.

If you still need to use the py2 version, I published a tag with the last py2 commit. You can get that version specifically with:

git clone https://github.com/tabatkins/bikeshed.git -b v0.9

This won't update again, tho, so it's in your best interest to update your Python anyway.

If you're using Bikeshed on CI, updating should be trivial; telling Travis or GitHub to use Python 3.7 is just a config option, like in https://github.com/tabatkins/bikeshed/blob/master/.travis.yml

[tabatkins]

@frivoal just pushed a very nice set of commits improving various little bits of the <wpt> element, most notably the new WPT Display: closed value and associated styles. When this is turned on, the <wpt> element is a <details> that starts closed, with the summary being a small, out-of-the-way little "TESTS" that doesn't visually interrupt at all.

This is looking so good that I think I'll flip it to the default soon, for non-TR documents. If you're currently use <wpt> and definitely do not want tests to show in your document, add a WPT Display: none metadata to your spec or your group's defaults.include file.

We flipped it on by default in the CSSWG just a few minutes ago, so in a little bit (once everything regens) you'll be able to see how it looks on any CSSWG spec - I recommend checking Color 4 and searching for "tests".

[svgeesus]

This is looking so good that I think I'll flip it to the default soon, for non-TR documents.

I would prefer to see them like this on /TR documents, too.

[tabatkins]

Ah yeah it's been nearly a year and the experience has been great, I'll just flip the default

[tabatkins]

As part of my quest to add typing hints to all of Bikeshed, I'm also ending up refreshing some old confusing code that dates back to my earliest implementation. Most recently, I did a decent rewrite of my biblio handling, which will likely cause some changes - in particular, I believe I now correctly handle the Default Biblio Status metadata (and its default, which is based on your spec's Status) in all places, which from the testsuite diff will probably affect a lot of references, switching them from snapshots to EDs or vice versa.

If anything looks wrong, please let me know.

[frivoal]

Notice of breaking change, effective for a while already and documented in #1773 (comment):
The ABSTRACTATTR macro is no longer supported by bikeshed. If you use that in your templates or documents, they need updating.