python-trio / async_generator

Making it easy to write async iterators in Python 3.5
Other
95 stars 23 forks source link

Fix syntax highlighting in README #12

Closed nicoddemus closed 6 years ago

nicoddemus commented 6 years ago

For some reason GH does not recognize .. code-block: python3, but .. code-block: python works even for Python 3 syntax.

codecov[bot] commented 6 years ago

Codecov Report

Merging #12 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #12   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           7      7           
  Lines         776    776           
  Branches       59     59           
=====================================
  Hits          776    776

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bd2868a...bb7929f. Read the comment docs.

njsmith commented 6 years ago

Ugh. You're not wrong, but I bet this will break syntax highlighting on pypi, because pygments definitely treats python and python3 differently. Probably we should at least file bugs on GitHub and pygments asking them to fix their things.

njsmith commented 6 years ago

I emailed support@github.com, and filed https://bitbucket.org/birkenfeld/pygments-main/issues/1415

I guess I'll give it a few days to see if either of them seems to be moving :-)

nicoddemus commented 6 years ago

Thanks, sorry I forgot to get back at this myself. 👍

njsmith commented 6 years ago

Github just added python3 as an alias for python in the library they use for syntax highlighting: https://github.com/github/linguist/pull/4026

I'm not sure how long this will take to flow from "committed to the open source library" to "deployed on the production site" – possibly a few weeks.

njsmith commented 6 years ago

But in any case I guess I'll close this, since the current solution works with pypi/sphinx and the github rendering will fix itself eventually, and in the mean time it's not too terrible. Thanks for bringing this up though :-)

nicoddemus commented 6 years ago

Sure thing, thanks for the update!