Skip to content
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

DOC Add installation instruction to docs #82

Merged

Conversation

BenjaminBossan
Copy link
Collaborator

I think the docs should have an installation instruction. Thus I added a new section there but LMK if I should put it elsewhere instead @skops-dev/maintainers


.. code-block:: bash

python -m pip install skops
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure why you prefer this to pip install skops.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This the recommended way in the docs. The reason I've seen in the past is that even though in general it's the same, in some situations pip install can lead to the package being installed globally, instead of the specific python environment. In contrast, python -m pip install will never fail where pip install works.

@adrinjalali adrinjalali merged commit c27fc6d into skops-dev:main Aug 9, 2022
@BenjaminBossan BenjaminBossan deleted the docs-add-installation-instruction branch August 9, 2022 12:06
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

Successfully merging this pull request may close these issues.

2 participants