Closed DimitriPapadopoulos closed 4 months ago
@larsoner Could you please have a look at this PR:
works around broken reST rendering
Keep in mind we use it in our sdist / on PyPI via readme
:
Renders into this page on release
https://pypi.org/project/codespell/
And it looks like pygments
rendering is working okay on a per-language basis at least from spot checking a few of them e.g.:
One bugfix is that the pip
lines should probably be console
rather than sh
I think?
In any case I think I'd prefer to keep the correct format specifiers and just wait for GH to fix their rendering at some point, and keep the nicer rendering on PyPI (and any editors that render .rst
on the fly correctly, etc.).
Agreed with @larsoner I think it's a bug from Gh rendering
Yes, that's a bug in GitHub rendering. As I wrote:
GitHub does not render reST
code::block::
properly, with most language specifiers. Remove language specifiers for now, until GitHub fix this issue.
It occurs with all of sh
, console
,python
, ini
, yaml
, but not console
and toml
.
I find decent rendering of the README in GitHub is more important than fancy syntax highlighting. Any way, you decide.
At least let's merge the second commit, which ensures better rendering through consistent indentation of reST code blocks.
Okay based on your edit how about a compromise where we change sh
->console
and keep toml
?
Let's keep it as is then. The real language type would be sh
. I guess GitHub doesn't support console
at all which is why it does not even try fancy rendering.
I have just kept the code-block::
indentation fix.
GitHub does not render reST
code::block::
properly, with most language specifiers. Remove language specifiers for now, until GitHub fix this issue.Fixes https://github.com/codespell-project/codespell/pull/3390#issuecomment-2020705461.