DOC Note on _contributors.rst as its presence is now clearer

scikit-learn · Nov 4, 2017 · 5a820a2 · 5a820a2 · qinhanmin2014 · Nov 9, 2017
1 parent 8e599c6
commit 5a820a2
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc/whats_new/_contributors.rst b/doc/whats_new/_contributors.rst
@@ -1,3 +1,12 @@
+
+..
+
+    This file maps contributor names to their URLs. It should mostly be used
+    for core contributors, and occasionally for contributors who do not want
+    their github page to be their URL target. Historically it was used to
+    hyperlink all contributors' names, and ``:user:`` should now be preferred.
+
+
 .. _Olivier Grisel: https://twitter.com/ogrisel
 
 .. _Gael Varoquaux: http://gael-varoquaux.info