Skip to content

DOCS: Review code examples in docs to improve legibility #928

@pydanny

Description

@pydanny

Autoformatting of Python code, especially Air tags is problematic in our docs. Especially for beginners. We can turn off the autoformatting of our docstrings using this technique:

<!-- blacken-docs:off -->
```python
# whatever you want
```
<!-- blacken-docs:on -->

Reference: https://github.com/adamchainz/blacken-docs?tab=readme-ov-file#markdown

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions