#34140: Format python code blocks in documentation files
-------------------------------------+-------------------------------------
Reporter: Paolo Melchiorre | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
format,black,snippet,example | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Joseph V Zammit):
Hi Paolo, what does this involve? I see these steps:
1. Install ​blacken-docs on my local and run it against current docs.
2. Manually inspect the result. If things look good move to step 3.
3. Add blacken-docs to the docs pre-commit configuration, as suggested
[#https://github.com/adamchainz/blacken-docs#usage-with-pre-commit here].
4. Add blacken-docs to the current docs CI steps. (I might have questions
on this.)
Does this make sense? Am I missing something?
--
Ticket URL: <https://code.djangoproject.com/ticket/34140#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/01070184480581b7-b5d15476-d805-4d3f-8f79-3c414ea93b96-000000%40eu-central-1.amazonses.com.
