Ship It!

Let's also indicate what versions we've dropped.

Missing some text after the version.

I realized, we assume the presence of this setting in our code, but we don't ever force it into existence anywhere. We either need to either make this a breaking requirement for all consumers, or we need to conditionalize access in some form (which is error-prone to do in every single case).
Let's discuss on Slack. We need a solution to this.

We should be specific about this being an issue in the form.

We should :py:class: this.

Since this is a development library, we probably need to go more into detail on this subject, link to the affected methods.

We need to specify where this applies to, so people can know where use_distinct is set.

:mailheader: role (legacy naming aside, this is the correct role to use).

Should use :pypi: for the reference.
Also, single backticks in ReST don't produce template literals, just broken references.

We should reference the thing include_bundles is on. Should use:

:py:attr:`Class.attr <path.to.Class.attr>`.


Otherwise the context will be lost.

This should use :pypi:.

Same here.

These need :py:func:.

Two blank lines before reference definitions.

This should reference the filter with :py:func:.

These should reference using :py:class:.

This should reference using :py:func:.

Typo: "a new new items".

This seems to be missing something?

We also now require Spina 3.1.x. This impacts extensions and any code importing our TypeScript.

We need to mention that Ink is now required for applications consuming Djblets, and what needs to be done there.

We removed a custom $.delay in favor of the jQuery one.

For configforms, we should document how TypeScript code is now expected to import from this (we flattened the namespace).

We fixed a focus recursion crash when there are multiple modalboxes on the screen using $.fn.modalBox.

For datagrids:

We now longer provide age1 through age5, month, or summary column styles.

Djblets UI elements now support dark mode.

Missing items for registries:

Registries are now thread-safe (we should explain the implications and which parts), using a reentrant lock.
Subclasses can override pre/post handlers for populate(), register(), unregister(), and reset(). Subclasses must move to this instead of overriding these methods in order to ensure thread safety.
The populated attribute is deprecated. We now have a state attribute.

We should specify explicitly that 3.2 support has been removed, since this is a major change.

We should mention the version we removed.

Keeping with prior releases, the second sentence should go in the description area. Makes it easier to skim.

Same note as above.
Also, it's not just the JavaScript, but anything outputting HTML as well. So maybe "consuming parts of Djblets that use JavaScript or provide HTML, ..."

We should also say that what this defaults to, and maybe give an example of changing this.

Let's link to Ink.

We don't really need it in the static media bundles. We just need it on the page. We're distributing as compiled CSS/JS files that can be used directly.
I'd say, "Assuming you have added the Ink CSS file to your page, ..."

:py:class:

Literals require two backticks in ReST.

This is far too dense to comfortably follow. It'll help readability a lot if we take these code samples and turn them into code blocks.

These should be :py:meth:. since they're pointing to methods on a class.
As-is, we're going to see the function names and not the parent classes. That mixed with us talking about two classes makes this a bit confusing.
I'd suggest we break this into two paragraphs, one per class, and add a reference for the class we're talking about. So, instead of "datagrid subclasses can ...", do a :py:class: with the DataGrid class. And then same with the Column class.

Description should be in its own paragraph. Summary lines should be concise and scannable.

This feels more like description content. Let's give it a more concise summary stating that we added the field, then explain the field.

We should reference the class.

These should be :py:meth:.

Can we link nose, so there's context for anyone not familiar?

Should be django.core.files.File.

:py:meth:

:py:meth:

Should be split into a summary / description.

Should be split into a summary / description list.

Summary / description.
The description isn't correct, though. I fixed this due to hitting it in production with the confirmation dialog for deleting a review within the Review Dialog. It blew up with crashes in the JavaScript console. Still operational, but we've been spamming crashes when bringing up a second dialog for many versions now.

Sounds like we're saying "expand" too many times, can take out the "to expand".

Might sound better to say "... methods that subclasses can ..."

Ship It!

Looks good! A few small changes.

Installation is always the first section in the release notes.

Two blank lines between content and reference declarations.

This will be 5.x, rather than 5.0.

Let's explicitly document 0.5.x.

This comment was resolved earlier, but we don't need data-theme= for Ink.

Ship It!