From 5a820a27fa597a66ff49b94bfdf9769c4f8e7ca5 Mon Sep 17 00:00:00 2001 From: Joel Nothman Date: Sat, 4 Nov 2017 22:09:15 +1100 Subject: [PATCH] DOC Note on _contributors.rst as its presence is now clearer --- doc/whats_new/_contributors.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/whats_new/_contributors.rst b/doc/whats_new/_contributors.rst index dfbc319da88f4..a80c220192582 100644 --- 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