webcrypto.dart icon indicating copy to clipboard operation
webcrypto.dart copied to clipboard

Consider using [!NOTE] blockquote for browser/platform compatibility notes

Open jonasfj opened this issue 9 months ago • 0 comments

In: https://pub.dev/documentation/webcrypto/latest/webcrypto/AesCtrSecretKey/encryptBytes.html

And a few other places we write: **Remark** ... to indicate that a particular browser or platform doesn't support a particular feature.

Instead of using this form, it'd be cool to use the [!NOTE] format.

Example

[!NOTE] Remark Firefox does not implement counter rollover for AES-CTR correctly. Picking a sufficiently large length and using a counter that isn't filled with 0xff will likely avoid counter rollovers. See bug 1803105 for details.

Markdown

> [!NOTE]
> Remark Firefox does not implement counter rollover for AES-CTR correctly. Picking a sufficiently large `length` and using a `counter` that isn't filled with 0xff will likely avoid counter rollovers. See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105) for details.

I think this should work with recent versions of dartdoc too! :rocket:

We should test it out locally first, and we should make sure to migrate all such remarks in one PR.

jonasfj avatar May 13 '24 09:05 jonasfj