python-guide icon indicating copy to clipboard operation
python-guide copied to clipboard

little mistake on one of your sites

Open Lady-Moonshadow opened this issue 7 years ago • 7 comments

Dear Kenneth, on your Side http://docs.python-guide.org/en/latest/dev/virtualenvs/#virtualenvironments-ref you want us to check the python version at "Make sure you’ve got Python & pip" - here you name the command "$ python --version" but you want to receive the python 3 version 3.6.2, so the command should be "$ python3 --version". (I think it's just a small copy paste mistake)

best regards Lisa :)

Lady-Moonshadow avatar Feb 26 '18 13:02 Lady-Moonshadow

@Lady-Moonshadow I think maybe it's intended that the user has seen the installation section first, e.g., http://docs.python-guide.org/en/latest/starting/install3/osx/#working-with-python-3

On that page, there's this:

The rest of the guide will assume that python references Python 3. You can simply choose to always invoke python3 instead, and much is backwards compatible. However, performing the following steps will set Python 3 as the default interpreter for python in a shell.

On mine and other co-workers machines, for example, python actually does run a version of Python 3.

Kenneth may very well want to clarify in the docs, and without knowing you any better, I'm glad you're here and making a contribution to something that wasn't clear! 👍

tcg avatar Feb 28 '18 02:02 tcg

I noticed that this issue is still open. Shall I go ahead and make the requested change? I think Lisa has a fair point that it's better not to make assumptions that someone has read the installation section of the guide first. Maybe some users like to jump around the sections.

tashachin avatar Nov 20 '18 14:11 tashachin

@tcg wrote

On mine and other co-workers machines, for example, python actually does run a version of Python 3.

Agreed. $ python could mean either 2.x or 3.x

This whole section assumes a lot of prior knowledge. It reminds me of a carnival ride that says "You must be THIS TALL to ride".

It assumes you know

  • Python comes in two versions, 2.x and 3.x
  • The difference between a GUI desktop and a command line interface
  • python and pip are commands run from the OS shell, not the Python shell
  • The difference between an OS shell and a Python shell
  • How to open an OS shell
    • On Windows, how to open a cmd.exe window or Powershell
    • On Linux, how to open a bash shell
    • On MacOS, how to open a terminal window

Maybe we should start with a Prerequisites section with relevant http links.

mpoulin avatar Nov 20 '18 16:11 mpoulin

Hi there,

I'm fairly new to python but I've been working on it. I've also been searching for ways to contribute to the community more.

I was a chemistry teacher for 20 years, so I do have quite a lot of experience writing clear technical instructions. I was poking around on here looking for some issues that I could manage to help with.

This one is still open, and I agree that the section could use a little reworking. Maybe I could take a stab at it?

skeptycal avatar Feb 14 '19 05:02 skeptycal

That would be great @skeptycal

mpoulin avatar Feb 14 '19 14:02 mpoulin

Great! I'll see what I can come up with. I'm fairly new to open source and contributing, so once I get something ... give me tips and I'll get it right.

skeptycal avatar Feb 17 '19 00:02 skeptycal

Two separate things:

  1. Is anyone actively working on updating the Installing Python 3 on Mac OS X? Like @mpoulin mpoulin wrote above there is a TON of assumed knowledge here.

I'm really stuck on the following paragraph:

The script will explain what changes it will make and prompt you before the installation begins. Once you’ve installed Homebrew, insert the Homebrew directory at the top of your PATH environment variable. You can do this by adding the following line at the bottom of your ~/.profile file

  1. If this is not being worked on right now, can anyone recommend where to begin understanding everything going on here?

I understand that I'm trying to get my computer to default to python3, which it is not doing right now.

But Googling "High Sierra PATH environment variable" doesn't yield anything useful.

What is my PATH environment variable? Where is my ~/.profile file?

optimisticamateur avatar Jul 17 '19 21:07 optimisticamateur