#34140: Format python code blocks in documentation files
-------------------------------------+-------------------------------------
Reporter: Paolo | Owner: nobody
Melchiorre |
Type: | Status: new
Cleanup/optimization |
Component: | Version: dev
Documentation | Keywords:
Severity: Normal | format,black,snippet,example
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
Now that we use Black for formatting the Django code, I think it would
help a lot to format the Python code blocks present in the documentation
with Black as well.
This would help those learning Django to find consistency between the code
format that is present in the documentation and that present in the GIT
repository.
It would also help the volunteers contributing to the documentation to
have a clear guideline on the format of the sample Python code and an
automatic formatter that relieves them of the worry of making mistakes.
I only know the Adam's [https://github.com/adamchainz/blacken-docs
blacken-docs] to achieve the goal but if I know others I invite them to
propose them.
--
Ticket URL: <https://code.djangoproject.com/ticket/34140>
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/0107018442e66878-e80b43b7-4c8c-46f3-bb08-e5854b05333e-000000%40eu-central-1.amazonses.com.
