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

PEP 8 part is misleading #115

Open
pochmann opened this issue Jul 11, 2017 · 1 comment
Open

PEP 8 part is misleading #115

pochmann opened this issue Jul 11, 2017 · 1 comment

Comments

@pochmann
Copy link

pochmann commented Jul 11, 2017

Your PEP 8 part at http://pymbook.readthedocs.io/en/latest/pep8.html is rather bad. It differs from the actual current PEP 8 and you make it look misleadingly official. Better use the actual current PEP 8 text, add a clear header saying that this is only a copy, and link to the original. Though I really don't get the point of copying it in the first place. I think it would be best for you to only summarize PEP 8, briefly explaining what it is, giving a few important examples, and then referring to the original document on the Python site for people interested in the whole thing.

I btw came across your page as the fifth result in a google search for "pep8" (and I see your GitHub repository is quite popular). So it's not insignificant. It might actually be misleading people already.

@kushaldas
Copy link
Owner

@pochmann Thanks for the report, I will fix it. I will most probably convert it into a link the actual docs.

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

No branches or pull requests

2 participants