Skip to content

Update pep8 RTD to point to pycodestyle #602

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

Closed
IanLee1521 opened this issue Nov 16, 2016 · 12 comments
Closed

Update pep8 RTD to point to pycodestyle #602

IanLee1521 opened this issue Nov 16, 2016 · 12 comments
Milestone

Comments

@IanLee1521
Copy link
Member

From #466 (comment)

Also, the note on http://pep8.readthedocs.io/en/release-1.7.x/ (where the "read documentation" points to) mentions the rename but doesn't provide links to either PyPI or RTD for the new name, both of which would be helpful.

@IanLee1521 IanLee1521 added this to the 1.7.1 milestone Nov 16, 2016
@JonathanDensil
Copy link

@IanLee1521 I am new to contributing to github projects. I read the contributing doc and am guessing I would first have to fork this project and then install virtualenv. Would it be possible for you to walk me through the process in resolving this issue please?

@IanLee1521
Copy link
Member Author

IanLee1521 commented Dec 16, 2016

Hi @JonathanDensil, thanks for your interest!

For forking, I would take a look at the Forking Projects guide.

For Virtualenv, I would take a look at their main documentation, specifically the Basic Usage section.

Additionally, the CONTRIBUTING page has an example of walking through the whole process.

@JonathanDensil
Copy link

Hi @IanLee1521 , I successfully forked the project and installed virtualenv, but I am using windows 10 and when I tried to run source venv/bin/activate it gave me an error saying:
`source : The term 'source' is not recognized as the name of a cmdlet, function, script file, or operable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
At line:1 char:1

  • source venv/bin/activate
  •   + CategoryInfo          : ObjectNotFound: (source:String) [], CommandNotFoundException
      + FullyQualifiedErrorId : CommandNotFoundException`
    

I believe this is because 'source' is a linux command. Just running 'activate' does not give an error, but no result is shown either. How would I activate the virtual environment on windows 10?

Interestingly (I'm not sure if this is right...):
pycodestyle\venv
pycodestyle\pycodestyle-venv
pycodestyle\pycodestyle-venv\Scripts\ENV

All of the paths have the same files in them, they look identical. That means that there is an activate and an activate.bat in each Scripts folder. I also don't have a bin folder (I suspect that bin is also only on linux)

@sigmavirus24
Copy link
Member

@JonathanDensil Did you read virtualenv's documentation on this? http://virtualenv.readthedocs.io/en/stable/userguide/#activate-script

@JonathanDensil
Copy link

Ahh, I was using powershell and it required an execution policy. It works on the cmd. Thank you for your help. Now, onto resolving this issue. What would be the procedure be in doing so?

@IanLee1521
Copy link
Member Author

Hi @JonathanDensil -- The typically workflow on GitHub, which we use, is:

  1. Fork the repo
  2. Edit the file(s) you need for your change
  3. Commit and push to your fork
  4. Submit a pull request back to this repo (the origin)

GitHub has some decent guides on these topics :

@JonathanDensil
Copy link

Hi @IanLee1521, well actually I was referring to this specific issue. I believe that you are referring to making a link for the words under the note section: pep8 to https://www.python.org/dev/peps/pep-0008/; and pycodestyle to https://pypi.python.org/pypi/pep8/1.7.0. If this is the case, I couldn't find the file to edit and add those links in the code base. The intro.rst file under docs doesn't include the note so I couldn't edit that section. Where would I be able to find that section?
image

@IanLee1521
Copy link
Member Author

I want to encourage you to poke around a bit on your own before just giving everything away, but the gotcha there is a bit odd. That link is to the release-1.7.x version of the docs, so you need to switch to that branch:

@JonathanDensil
Copy link

Ohh I see. I have downloaded the GitHub for Windows and have forked the repository. I have been doing some messing around with a small repository that I made for myself. Not to be hasty or anything, I am just really excited to have my first contribution to a public open source project, just so that I can get the ball rolling and contribute more. So, if I add the link to the index.rst in my forked repository and then commit and push it to the release-1.7.x branch in my forked repository and then submit a pull request, would that be acceptable?

@JonathanDensil
Copy link

Hi @IanLee1521, I edited the index.rst document, committed the changes to my fork and then created a pull request back to the original repository. It says that all checks have failed, but I presume that it was because index.rst is not a python file. Please review my pull request.

@JonathanDensil
Copy link

Hi @sigmavirus24 and @IanLee1521, I corrected the problem with the previous commit, changed the link addresses and abided by the line length guide as requested by sigmavirus24 in his review of my previous commit. I hope that I have done it right this time. Thank you, please review.

sigmavirus24 pushed a commit that referenced this issue Dec 27, 2016
This will render for users who look at pep8 1.7.x's documentation
and hopefully help inform them that pep8 is deprecated and now
replaced by pycodestyle.

Closes #602
@hugovk
Copy link
Contributor

hugovk commented Oct 10, 2017

I think this issue can now be closed; #606 has been merged which added this to https://pep8.readthedocs.io/en/release-1.7.x/:

image

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

4 participants