[GitHub] aaronmarkham commented on a change in pull request #10827: [MXNET-405][WIP] Add 2 new pipelines to the Official CI and run nightly tests.

[GitBox <gi...@apache.org>]

aaronmarkham commented on a change in pull request #10827: [MXNET-405][WIP] Add 2 new pipelines to the Official CI and run nightly tests. 
URL: https://github.com/apache/incubator-mxnet/pull/10827#discussion_r196516447
 
 

 ##########
 File path: docs/install/index.md
 ##########
 @@ -84,7 +84,7 @@ $ wget https://bootstrap.pypa.io/get-pip.py && sudo python get-pip.py
 **Step 2** Install MXNet with OpenBLAS acceleration.
 
 ```bash
-$ pip install mxnet
+$ sudo pip install mxnet
 
 Review comment:
   I can say that I lean towards not having `sudo`, but telling people they might need it. If we know the specific conditions, like only Mac users, or x state, then we should say so.
   When you use `sudo`, it can cause downstream context problems which can be baffling and hard to diagnose, so I actually prefer using `pip install package --user` and keeping the installation context as narrow as possible. Would love to have someone that is an expert on this chime in a provide best practices. 
   
   Also, isn't `nose` mostly for testing? Why tell the user they need to use `sudo` when they actually don't. They only need it if they want to run tests. Having them do something that is an edge case for CI or testing is the wrong approach.
   
   Coming full circle, why are we doing this? The concept of automatically testing the instructions is good, but you shouldn't modify the instructions for the sake the test. 
   
   Why don't you parse the install instructions, and inject `sudo` yourself as part of the script?
   
   
   
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services