Documentation for Window users [#40] by Cheukting · Pull Request #47 · python-sprints/python-sprints.github.io

Cheukting · 2018-03-04T00:42:46Z

Adding documentations for Window users

# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

datapythonista

Thanks a lot, just some minor comments that should let users read your comments easier.

datapythonista · 2018-03-04T18:26:57Z

pandas/guide/source/pandas_setup.rst


    | ``git remote add upstream https://github.com/pandas-dev/pandas``

+(For Window Users: download git for Windows <https://gitforwindows.org/> and run Git Bash in the directory where you want the copy of pandas source code with the same commends as above.)


I think it'll be easier for user to find it (or to skip it) if instead of the comment in brackets we use in all the comments for Windows the sphinx .. note:: directive. This will create a (yellow I think) box. If at the beginning of it we have "Windows users" in bold, Linux and Mac users will skip it easily.

Then, I think in Sphins links usually are between back quotes ended with an underscore. Ignore this comment if it renders the way you want.

datapythonista · 2018-03-04T18:32:06Z

pandas/guide/source/pandas_setup.rst

 * Install pandas development dependencies:
    ``conda install -c defaults -c conda-forge --file=<pandas-dir>/ci/requirements-optional-conda.txt``

+(For Window users: run the above commends in Anaconda Prompt)


Personally I prefer to be more specific and not assume much prior knowledge from users, and I'd let them know where to find the Anaconda Prompt.

Also, if you find an easy way to rewrite this paragraph so this doesn't come at the end, that would be great. To avoid users following the above instructions in Windows, to realize when they reach this point that they were doing it the "wrong" way.

datapythonista · 2018-03-04T18:35:56Z

pandas/guide/source/pandas_setup.rst

 Besides the Python `.py` files, pandas source code includes C/Cython files
 which need to be compiled in order to run the development version of pandas.

+For Window Users: you'll need to install the compiler toolset. Depending on which version of Python you care about, you will need to choose a different download.


As users are using Anaconda, I think we can assume they'll be using the latest version of Python, and simplify this. If you want, with a note at the end with the link to Python 2.7.

datapythonista · 2018-03-04T18:36:35Z

pandas/guide/source/pandas_setup.rst


 The process will take several minutes.

+(For Window users: run the above commends in Anaconda Prompt)


Same as before, I'd try to tell them users to use Anaconda Prompt before the commands, not after.

Typo in commands

datapythonista · 2018-03-04T18:37:42Z

pandas/guide/source/pandas_setup.rst

@@ -108,3 +131,5 @@ To check in which branch are you:

 To change to another branch:
    | ``git checkout <branch_name>``


Same, and if we say this here, we should probably say it at the beginning, when cloning...

datapythonista

Looks much better. Some typos and comments on things to improve the style.

Thanks!

datapythonista · 2018-03-06T11:09:54Z

pandas/guide/source/pandas_setup.rst


 The process will take several minutes.

+(For Window users: run the above commends in Anaconda Prompt)


I think you forgot this one for converting to a note?

datapythonista · 2018-03-06T11:09:56Z

pandas/guide/source/pandas_setup.rst

 to submit a pull request, so they are included in pandas.

+.. note::
+   for Window users run above comments with Git Bash at the colned pandas floder


Capital "F"

comments instead of commands

typo in cloned

datapythonista · 2018-03-06T11:14:26Z

pandas/guide/source/pandas_setup.rst

 * Fork the `pandas repository <https://github.com/pandas-dev/pandas>`_ on GitHub by click on the top-right `Fork` button
+
+.. note::
+    For Window Users: download git for Windows <https://gitforwindows.org/>


I think it'd be clearer for users to have **Windows users:** in bold at the beginning of each note block. Being in bold and always in the same way, users will clearly perceive this is for windows users only.

datapythonista · 2018-03-06T11:14:57Z

pandas/guide/source/pandas_setup.rst

+* Download and install `Anaconda <https://www.anaconda.com/download/>`
+
+.. note::
+    For Window users, go to the start menu, find Anaconda Prompt inside the Anaconda floder


typo in folder

datapythonista · 2018-03-06T11:15:07Z

pandas/guide/source/pandas_setup.rst

+
+.. note::
+    For Window users, go to the start menu, find Anaconda Prompt inside the Anaconda floder
+    and run the above commends in Anaconda Prompt


typo in commands

datapythonista · 2018-03-06T11:15:33Z

pandas/guide/source/pandas_setup.rst

+.. note::
+    For Window Users, you'll need to install the compiler toolset:
+
+    for Python 3.6 - Install Visual Studio 2017, select the Python development workload


Capital "F"

datapythonista · 2018-03-06T11:15:44Z

pandas/guide/source/pandas_setup.rst

+    for Python 3.6 - Install Visual Studio 2017, select the Python development workload
+    and the Native development tools option <https://www.visualstudio.com/>
+
+    for Python 2.7 - Microsoft Visual C++ Compiler for Python 2.7


Capital "F"

datapythonista · 2018-03-06T15:52:40Z

Thank you!

Cheukting and others added 4 commits February 8, 2018 19:41

Clone form github

196113c

Cloned from Github

9ce47a3

Merge remote-tracking branch 'upstreem/master'

f343f42

# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

Added comments for Window users

298c943

Cheukting mentioned this pull request Mar 4, 2018

Add section for Windows in pandas set up guide #40

Closed

datapythonista reviewed Mar 4, 2018

View reviewed changes

change instruction for Window users

74b0cb0

datapythonista reviewed Mar 6, 2018

View reviewed changes

Fixed typo

3be58c2

datapythonista merged commit 57c9988 into python-sprints:master Mar 6, 2018


		\| ``git remote add upstream https://github.com/pandas-dev/pandas``

		(For Window Users: download git for Windows <https://gitforwindows.org/> and run Git Bash in the directory where you want the copy of pandas source code with the same commends as above.)


		The process will take several minutes.

		(For Window users: run the above commends in Anaconda Prompt)

		@@ -108,3 +131,5 @@ To check in which branch are you:

		To change to another branch:
		\| ``git checkout <branch_name>``

Conversation

Cheukting commented Mar 4, 2018

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datapythonista Mar 4, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datapythonista commented Mar 6, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

datapythonista Mar 4, 2018 •

edited

Loading