mxnet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] aaronmarkham opened a new pull request #12604: Remove pip overwrites
Date Wed, 19 Sep 2018 21:29:15 GMT
aaronmarkham opened a new pull request #12604: Remove pip overwrites
URL: https://github.com/apache/incubator-mxnet/pull/12604
 
 
   ## Description ##
   This PR removes the overwriting of pip install instructions on the website. When we make
updates to source to have the correct info, this script will overwrite it based on some dated
logic. Now that we have consolidated install info, it doesn't make sense to have this injection
happen. Also, the injection was a nuisance anyway since it would be so hard to track down.
No one ever sees it happen in local dev builds of the docs.
   
   This also resolves point 3 in the recent feedback thread about MXNet.
   https://lists.apache.org/thread.html/fe2e883b2daf06e03283e4f3fcb3312c811a6e4cef8dbf1768ec29eb@%3Cdev.mxnet.apache.org%3E
   
   This script was taking instructions that were correct in the source of the page and making
them incorrect when the site was being published. (by add --pre)
   
   The script also swaps out links to the examples based on your current version... which
doesn't make a lot of sense because the example may not have existed for the version of the
site that you're on. I guess it made sense if you were time-traveling through the site versions...
maybe. Anyway, that's deleted by this PR too.
   
   ## Comments
   Generally, I would say that these kind of magical injections that happen at web publishing
time are a bad idea because it makes the developer go crazy. They put in a link in their source,
and then it gets magically butchered by an invisible script well after their code was merged.
I hope to eventually get rid of this entire script once the versions dropdown is better integrated
with the API docs.
   

----------------------------------------------------------------
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

Mime
View raw message