DOC: Added documentation for ImportError's #30912
Conversation
There was a problem hiding this comment.
Thanks for working on this @gonemad97, nice work. Added few comments, but looks great.
| Handling ImportErrors | ||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| If you encounter an ImportError,it usually means that Python couldn't find pandas in the list of available |
There was a problem hiding this comment.
| If you encounter an ImportError,it usually means that Python couldn't find pandas in the list of available | |
| If you encounter an ImportError, it usually means that Python couldn't find pandas in the list of available |
|
|
||
| One way you could be encountering this error is if you have multiple Python installations on your system | ||
| and you don't have pandas installed in the Python installation you're currently using. | ||
| In Linux/Mac you can run "which python" on your terminal and it will tell you which is the Python you're |
There was a problem hiding this comment.
better use double backticks for which python.
| One way you could be encountering this error is if you have multiple Python installations on your system | ||
| and you don't have pandas installed in the Python installation you're currently using. | ||
| In Linux/Mac you can run "which python" on your terminal and it will tell you which is the Python you're | ||
| using. If it's something like "/usr/bin/python", you're using the Python from the system.(Not recommended) |
There was a problem hiding this comment.
| using. If it's something like "/usr/bin/python", you're using the Python from the system.(Not recommended) | |
| using. If it's something like "/usr/bin/python", you're using the Python from the system, which is not recommended. |
|
|
||
| If you used Python before you may have used virtual environments and pip. While this is fine for many | ||
| Python projects (e.g. Django), when using data projects (pandas, numpy, tensorflow, etc.) this is discouraged. | ||
| It's easily susceptible to installation errors and the libraries can run slower while using pip to perform |
There was a problem hiding this comment.
| It's easily susceptible to installation errors and the libraries can run slower while using pip to perform | |
| It's easily susceptible to installation errors in non-Python dependencies and the libraries can run slower while using pip to perform |
small detail, but I think it's better to clarify, since we don't want to give the impression that pip is unreliable.
| It's easily susceptible to installation errors and the libraries can run slower while using pip to perform | ||
| installations. | ||
| The widely used solution to this problem is to use conda. You can find simple installation instructions | ||
| for pandas in this document: https://dev.pandas.io/getting_started.html. |
There was a problem hiding this comment.
| for pandas in this document: https://dev.pandas.io/getting_started.html. | |
| for pandas in this document: /getting_started.html. |
The dev.pandas.io domain is probably going to disappear, and the production page anyway will be in pandas.io. But it's better to not use the domain, in case we change it in the future.
Also, it's probably better to use something like (or at least make the link clickable.
You can use the simple `installation instructions </getting_started.html>`_ in the pandas website.
|
|
||
| If you get Python 2.7.x, then try the following command to install pandas:: | ||
|
|
||
| sudo pip2 install pandas |
There was a problem hiding this comment.
Remove this last part please, we surely don't want anyone to install pandas in the root environment as root. :)
datapythonista
changed the title
|
I've made the changes you've mentioned! While building on my system, I didn't face any issues, but while building it here, I'm unable to find the reason for the build failure. Could you help me out @datapythonista ? |
doc/source/getting_started/10min.rst
Outdated
| @@ -16,6 +16,8 @@ Customarily, we import as follows: | |||
| import numpy as np | |||
| import pandas as pd | |||
|
|
|||
| Note: In case you encounter an import error, :ref:`Handling ImportErrors` section of installation documentation. | |||
There was a problem hiding this comment.
This is the CI error: https://github.com/pandas-dev/pandas/pull/30912/checks?check_run_id=388068051#step:6:4623
I don't think you can add a link using the title section. You'll have to create a label before the title section, and link with the label. You should plenty of examples in the docs, but the label should be something like:
.. _install.import_errors:
and this link something like:
:ref:`Handling ImportErrors<install.import_errors>`
There was a problem hiding this comment.
Thank you so much for the help!! I felt that it was an unnecessary line either way so on removal, the checks passed.
|
@datapythonista Can you check if this can be merged? All the checks have passed! |
|
Thanks @gonemad97 |
…stall.rst
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diff