Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish readme #373

Merged
merged 3 commits into from
Feb 16, 2022
Merged

Polish readme #373

merged 3 commits into from
Feb 16, 2022

Conversation

WhyNotHugo
Copy link
Contributor

Proposed change

This simple PR updates the README with a few minor items:

  • Use proper print functions. The existing README use print statements, which are from ancient python versions and don't work on any current python version.
  • Remove unicode markers from sample strings. This just adds noise and hurts legibility, and, again, is no longer a thing.
  • Explicitly mark all code blocks. Currently, autodetection is not getting them all right, and the highlighting for many of the blocks is off. These improvements will make all of them render properly (both on GitHub and PyPI).

I'd suggest reviewing each commit individually, it's a lot easier to read when doing so.

Type of change

  • Documentation or code sample

Checklist

Skipping the checklist since the changes are documentation-only.

Hugo Osvaldo Barrera added 2 commits February 16, 2022 20:07
Copy-pasting the examples from the README has not worked for a long time
since the `print` statements used an ancient syntax that's not valid
Python.
These mostly add noise to the README, and were only relevant for Python
2.
@WhyNotHugo WhyNotHugo mentioned this pull request Feb 16, 2022
1 task
@WhyNotHugo
Copy link
Contributor Author

This is a rebase of #324

Many of them are not highlighted (or highlighted wrongly) since the
auto-detection isn't picking everything up correctly.

Marking all code blocks properly so they all get highlighted as
expected.
@balloob balloob merged commit f96b0d8 into picklepete:master Feb 16, 2022
@WhyNotHugo
Copy link
Contributor Author

WhyNotHugo commented Feb 16, 2022 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants