From e2685b6ba578a718ec1ba49014f91478a1e413ec Mon Sep 17 00:00:00 2001 From: Jake Vanderplas <vanderplas@astro.washington.edu> Date: Wed, 21 Dec 2011 01:56:06 -0800 Subject: [PATCH] DOC: add warning that utils should only be used internally --- doc/developers/index.rst | 2 +- doc/developers/utilities.rst | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/developers/index.rst b/doc/developers/index.rst index eb127026b6..1d70c1c9bc 100644 --- a/doc/developers/index.rst +++ b/doc/developers/index.rst @@ -71,7 +71,7 @@ repository on 2. Fork the `project repository <http://github.com/scikit-learn/scikit-learn>`__: click on the 'Fork' button, at the top, center of the page. This creates a copy of - the code on the github server where you can work. + the code on the GitHub server where you can work. 3. Clone this copy to your local disk (you need the `git` program to do this):: diff --git a/doc/developers/utilities.rst b/doc/developers/utilities.rst index 466e821647..bf70d5cd59 100644 --- a/doc/developers/utilities.rst +++ b/doc/developers/utilities.rst @@ -8,10 +8,12 @@ Scikit-learn contains a number of utilities to help with development. These are located in :mod:`sklearn.utils`, and include tools in a number of categories. All the following functions and classes are in the module :mod:`sklearn.utils`. -Please note that these utilities are meant to be used internally within -scikit-learn. They are not guaranteed to be stable between versions of -scikit-learn. Backports, in particular, will be removed as the scikit-learn -dependencies evolve. +.. warning :: + + These utilities are meant to be used internally within the scikit-learn + package. They are not guaranteed to be stable between versions of + scikit-learn. Backports, in particular, will be removed as the scikit-learn + dependencies evolve. .. currentmodule:: sklearn.utils -- GitLab