Add support for Ruff's docstring-code-format

[blink1073]

Ruff has a replacement for blacken-docs: astral.sh/blog/ruff-v0.1.8#formatting-code-snippets-in-docstrings.

In Jupyter Server we're skipping PC111 for now.

[henryiii]

It doesn’t support .md or .rst files quite yet. It should soon.

[blink1073]

Ah, good call out, thanks!

[nstarman]

When it does support these file types, then this can replace blacken-docs, right? Answered.

astral-sh/ruff#8237

[jarrodmillman]

When using ruff for docstring formatting, should repo-review mark not using blacken-doc in red?

And this link doesn't seem to exist: https://learn.scientific-python.org/development/guides/style/#PC111

[henryiii]

This check is for formatting code samples in docs (not docstrings), which I think ruff doesn’t support yet (basically all the pieces are there, but not the infrastructure. If the link is missing, that’s a bug, will check!

[jarrodmillman]

If we add - id: ruff-format in .pre-commit-config.yaml, we can add this

[tool.ruff.format]
docstring-code-format = true

to pyproject.toml to enable some docstring code formatting. Is it worth mentioning this option? If not, should we be cautioning against it.

https://docs.astral.sh/ruff/formatter/#configuration

[henryiii]

I think we should be recommending it, but we should also make sure we don't have overlap with blacken-docs trying to format code blocks in python files. I'd not thought of it doing that, but if it does, we should note how to avoid it.