Skip to content
This repository has been archived by the owner on Jun 12, 2023. It is now read-only.

Update README.md #14

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #14

wants to merge 2 commits into from

Conversation

Aya-S
Copy link
Contributor

@Aya-S Aya-S commented Sep 26, 2019

updating README.md with more explicit initialization steps

updating README.md with more explicit initialization steps
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the improvements, added couple of comments, but looks good to me.

README.md Outdated

- Create a conda enviroment based on environment.yml
```sh
conda env create -f environment.yml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need the -f environment.yml if the name of the file is environment.yml, since it's conda's default. Feel free to leave it if you prefer to be explicit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know that was the default, good to know.

README.md Show resolved Hide resolved
README.md Outdated
- https://github.com/MacPython/pandas-wheels
- https://github.com/pandas-dev/pandas

- Be sure to initialize repos
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small thing, but may be a colon at the end to show that you're talking about the next command (thought initially you were talking about the previous list of repos)

Implemented comments made on last PR
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks for the update


- Create a conda enviroment based on environment.yml:
```sh
conda env create
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be conda env create -f environment.yaml?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

environment.yml is the default conda file name, so not needed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, even if it is the default, I find leaving it out just confusing (for all people that don't know or directly remember that this is the default)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I see the non-explicit form is confusing to people. will change it back :D

- https://github.com/MacPython/pandas-wheels
- https://github.com/pandas-dev/pandas

 
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this required for anything?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It introduces a newline. for better readability and clearer separation between the commands

@jbrockmendel
Copy link
Member

Doesn't need to be part of this PR, but in running for the first time I found "make sure docker daemon is installed+running" would be useful

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants