kennethreitz / pep8.org

PEP 8, for Humans.

pep8.org

PEP 8, for Humans.

---

If you're interested in financially supporting Kenneth Reitz open source, consider visiting this link. Your support helps tremendously with sustainability of motivation, as Open Source is no longer part of my day job.

Developing

If you serve this locally from 0.0.0.0, the fonts will display properly. They are blocked on all domains except 0.0.0.0 and pep8.org.

An easy way to do this:

$ python -m SimpleHTTPServer #python2

or

$ python -m http.server      #python3

Syncing PEP 8 changes

pep8.org mirrors the original PEP 8 document at www.python.org/dev/peps/pep-0008/.

Whenever the original PEP 8 at python.org gets updated we need to migrate these changes to pep8.org. This process is difficult to automate because manual style and formatting tweaks were made to the original source material to create index.html.

To migrate the latest changes from the original PEP 8 source do the following:

• Look at the source control history for the original PEP 8 and compare it with what's live on pep8.org. (As of 2019-06 we're tracking rev 2f8f1ec.)

• Apply the missing changes to index.html and create a pull-request to get them reviewed and live on pep8.org

Deployment

Automatically deployed on Netlify on each push to master.

pep8.org's Issues

TOC wrapped-header line spacing too large

.toc-link.h1 has a line-spacing in it that makes wrapped heading names hard to visually see what's one or two. Without mouse-over highlighting, the 3 headings looks like 4.

I'm white-belt in CSS-fu, but something like a margin/padding to split up the headers while reducing the line spacing tightens up wrapped-headers but keeps the inter-header-spacing.

SSL Certificate Hostname Mismatch

There is a bit of an issue with the site.

Your SSL Cert appears to have an issue. Best guess to me (and the browser) is there is a hostname mismatch:

Perhaps something in Heroku needs a change?

I know this isn't a huge issue, certainly. Just think it would be relatively trivial to fix? I just figured you might want to be aware, especially since the site will always throw an error for anyone who automatically re-directs all traffic to https://* (such as myself, wherever possible). I note that I didn't have an issue in chrome with the extension HTTPS everywhere plugged in, however the FireFox version tried to force it and gave me the same error (I grabbed the screenshot from safari since its the best layout for this sort of thing I find)

2 broken links at http://pep8.org/#function-annotations

At chapter http://pep8.org/#function-annotations:
first line of the chapter and 1st line of 2nd paragraph have broken links "http://pep8.org/pep%20484".

Font issue with headings on MacOS X with Safari

This does not occur with Chrome and Firefox, only Safari. I am using MacOS X 10.11

pep8 update!

https://groups.google.com/forum/#!topic/dev-python/XsapBulcleU

Table of contents on the side

The page is pretty long and you get lost easily. I suggest displaying a fixed ToC on the side, either left or right, if the page is wide enough (i.e. not on mobile).

Bonus points if the ToC automatically highlights which section you're reading, using JavaScript.

Example: http://euw.leagueoflegends.com/en/news/game-updates/patch/patch-62-notes

Sync latest PEP 8 changes

Hey @kennethreitz, I love your work and I've been referring people to pep8.org every time someone asked for an "easier to read" representation of the original PEP 8.

As per our conversation at PyCon I'd love to help with keeping pep8.org up to date and I'm planning to submit a PR that pulls in the latest changes from the original pep-0008.txt file.

Looking at the hg history for the original PEP 8 and comparing it with what's live on pep8.org, the latest changeset that was migrated to pep8.org is this one: https://hg.python.org/peps/rev/19ef54ed6aaa

There are several changes that happened after that and I'll put together a pull-request to make those updates over the next few days. This issue is mainly a mutex to avoid duplicate work.

If you think what I wrote makes sense there's no need to reply and I'll ping you once I've got the PR ready. Thanks again for running pep8.org!

— Dan

margin-top of .toc pushes the bottom part of TOC off the screen

The lowest part of Table of Contents is not visible when you scroll all the way down.

Removing margin-top from .toc fixes it.

Confusing font used for code comments

Code blocks on pep8.org use the font "Operator Mono".

Comments in the code blocks are italicized. The italicized font is significantly different than the regular unstyled form. Specifically, it is in faux-cursive, with "r", "s", "f", "l" written in their cursive form, while still being monospace, with the letters separate from each other. Lower-case "L" in particular looks a lot like "e", as they are both almost the same height.

IMO as a non-native speaker/reader of English, this reduces the readability of the text.
This is totally subjective. I'm reporting this in case it bothers others.

Wide code block looks odd

Hi @kennethreitz 👋

I noticed that code blocks do not always show a horizontal scroll-bar (see Function Annotations):

At first glance it looks broken until you find out that you can actually scroll to inspect the full line.

I think it makes sense to always show the scroll-bar or find a better way of indicating that there's more code if you scroll to the right.

Nice fonts 😸

Update: Specs OS X 10.11.3, Firefox 44.0.2

transfer back to kennethreitz

we'll take turns :)

Please update your binary operator line break

Hello,

Binary operator line break was changed in PEP8, please update your beautiful guide.
Check section "Should a line break before or after a binary operator? " in PEP8.

Best regards,

JM