From 92e0704a97b3b7669ca535a3db357a0017ecf689 Mon Sep 17 00:00:00 2001 From: Joel Nothman Date: Thu, 8 Aug 2019 15:49:57 +1000 Subject: [PATCH 1/2] Versionwarning script --- versionwarning.js | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 versionwarning.js diff --git a/versionwarning.js b/versionwarning.js new file mode 100644 index 0000000000000..f213fe3d8654e --- /dev/null +++ b/versionwarning.js @@ -0,0 +1,31 @@ +(() => { + var latestStable = '0.21'; + var goodPaths = ['stable', 'dev', latestStable]; + var showWarning = (msg) => { + $('.body[role=main]').prepend( + '

' + msg + '

') + }; + if (location.hostname == 'scikit-learn.org') { + var versionPath = location.pathname.split('/')[1]; + if (!goodPaths.includes(versionPath)) { + showWarning('You are looking at documentation for an old release of ' + + 'Scikit-learn (version ' + versionPath + '). Try the ' + + 'latest release or ' + + 'development ' + + 'versions.') + } else if (versionPath == 'dev') { + showWarning('You are looking at documentation for the unstable ' + + 'development version of Scikit-learn. See also the ' + + 'latest release ' + + 'version.') + } + } +})() From a7a540a2db9816dd25591ba2f23405f1020ab128 Mon Sep 17 00:00:00 2001 From: Joel Nothman Date: Tue, 13 Aug 2019 00:46:09 +1000 Subject: [PATCH 2/2] Improvements to wording (some due to reviews) --- versionwarning.js | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/versionwarning.js b/versionwarning.js index f213fe3d8654e..651e20505faf6 100644 --- a/versionwarning.js +++ b/versionwarning.js @@ -1,4 +1,4 @@ -(() => { +(function() { var latestStable = '0.21'; var goodPaths = ['stable', 'dev', latestStable]; var showWarning = (msg) => { @@ -16,16 +16,19 @@ if (location.hostname == 'scikit-learn.org') { var versionPath = location.pathname.split('/')[1]; if (!goodPaths.includes(versionPath)) { - showWarning('You are looking at documentation for an old release of ' + + showWarning('This is documentation for an old release of ' + 'Scikit-learn (version ' + versionPath + '). Try the ' + - 'latest release or ' + + 'latest stable ' + + 'release (version ' + latestStable + ') or ' + 'development ' + - 'versions.') + '(unstable) versions.') } else if (versionPath == 'dev') { - showWarning('You are looking at documentation for the unstable ' + - 'development version of Scikit-learn. See also the ' + - 'latest release ' + - 'version.') + showWarning('This is documentation for the unstable ' + + 'development version of Scikit-learn. (To use it, ' + + 'install the nightly build.) ' + + 'The latest stable ' + + 'release is version ' + + latestStable + '.') } } })()