Refs #34140 -- Applied rst code-block to non-Python examples. #16537
Conversation
95c849d to
f371ebd
Compare
|
Great work @carltongibson |
There was a problem hiding this comment.
Thanks for the huge amount of grunt-but-not-so-grunt work in this @carltongibson !!
This indeed will make the commits in PRs to get to "blacken-docs" cleaner. I think you had suggested this but I only understand what you meant now 🤦♂️
In any case thanks! I spotted some very, very minor double-colon "typos". And if there's anything I didn't spot I think should be easy-to-fix later on 👍
Thanks again!
|
it's an amazing job. I've only added a few comments, most of which are questions rather than corrections. |
There was a problem hiding this comment.
@carltongibson thanks for all your answers.
For me this PR can be merged.
There was a problem hiding this comment.
@carltongibson Thanks for you humongous work 🥇 ⛰️
I don't like bulk updates, but, as far as I'm aware, we have no choice 😐 :
Should we also remove (currently unused 🤔 ) highlight directives?:
howto/deployment/wsgi/uwsgi.txt:.. highlight:: bashhowto/deployment/wsgi/gunicorn.txt:.. highlight:: bashhowto/deployment/asgi/daphne.txt:.. highlight:: bashhowto/deployment/asgi/hypercorn.txt:.. highlight:: bashhowto/deployment/asgi/uvicorn.txt:.. highlight:: bashinternals/contributing/writing-code/unit-tests.txt:.. highlight:: pythoninternals/contributing/triaging-tickets.txt:.. highlight:: consoleinternals/howto-release-django.txt:.. highlight:: consoleref/contrib/gis/install/index.txt:.. highlight:: consolereleases/1.0-porting-guide.txt:.. highlight:: pythontopics/security.txt:.. highlight:: html+djangotopics/i18n/translation.txt:.. highlight:: pythontopics/i18n/translation.txt:.. highlight:: javascripttopics/i18n/translation.txt:.. highlight:: pythontopics/i18n/translation.txt:.. highlight:: pythontopics/templates.txt:.. highlight:: pythontopics/forms/modelforms.txt:.. highlight:: pythontopics/cache.txt:.. highlight:: python
28f95ad to
9de9e35
Compare
|
Thanks @felixxm!
Yep, me neither. They're recipe for trouble... — but yes, necessary if we're going to proceed here. I applied all the suggestions and removed the |
Regardless of the future PR for blacken-docs, this PR I believe will greatly improve the correctness of all code blocks highlight by greatly increasing the documentation accessibility. Well done! |
|
Thanks @pauloxnet 😊 it's not that I think it's not worth it, but I'm pulled both ways (ambivalent) 😛 |
|
Presumably this and future related commits would be good candidates to add to the git-blame-ignore-revs file? 🤔 |
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for reviews.
Yes, I'll add it to the |
|
A little late to the party here, but all LGTM 👍 |
Looking to push forward the blacken-docs effort, applied the required
code-blocksthroughout.But I really don't want this to go stale. 😅 — so can we decide quickly please.
Note: we loose the ability to set default for a page say — this was used in template docs, and in the ORM docs, where there are lots of
pyconexamples back to back often.I feel a bit sad about this, but I think it's probably worth doing to get the blacken-docs into play. (Eye on the goal 😜)
We'd then just have
::for Python throughout the project.Moving is a one-time cost, that I've paid here.
Also, use of the override wasn't consistent. I think we're likely in a better world the other side of this change if we go for it.
@adamchainz Can I ask you to review and confirm we're going for this. (On balance I'm probably for it but I'd like you to champion it assuming you're +1, which I think you are.)
//cc @jvzammit @pauloxnet — hopefully this frees #16496 to be easier.