[issue12652] Move documentation of test.support into the devguide
New submission from Eli Bendersky <eliben@gmail.com>: First step in transition: Attaching a patch to devguide's runtests.rst to incorporate existing test.support documentation from 3.3 head, with some small markup changes suitable for the devguide. ---------- components: Devguide files: devguide_test_support.1.patch keywords: patch messages: 141337 nosy: brett.cannon, docs@python, eli.bendersky, ncoghlan priority: low severity: normal stage: patch review status: open title: Move documentation of test.support into the devguide type: behavior Added file: http://bugs.python.org/file22790/devguide_test_support.1.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Barry A. Warsaw <barry@python.org> added the comment: As I just mentioned on python-dev (via Gmane), I'm uncomfortable with moving the documentation for test.support into the devguide. ---------- nosy: +barry _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Changes by Éric Araujo <merwok@netwok.org>: ---------- nosy: +eric.araujo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Changes by Sandro Tosi <sandro.tosi@gmail.com>: ---------- nosy: +sandro.tosi _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Georg Brandl <georg@python.org> added the comment: -1 from me as well. ---------- nosy: +georg.brandl _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Nick Coghlan <ncoghlan@gmail.com> added the comment: Barry convinced me that the test.support docs need to stay in the same repo as the code they document, so -1 from me as well. Changed issue title to reflect the real problem that inspired this suggestion (i.e. test.support.unlink et al appearing in the docs index alongside the actual functions they wrap). Is there a :noindex: directive that will tell Sphinx not to index an entire section? ---------- title: Move documentation of test.support into the devguide -> Keep test.support docs out of the global docs index _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Eli Bendersky <eliben@gmail.com> added the comment: Nick, fair enough, but I think it would be more appropriate (and useful) to close this issue as rejected and open a new one. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Georg Brandl <georg@python.org> added the comment: Why is it more useful to open a new issue for the same problem? Nick: there is no such option right now, but I can customize our Sphinx build so that test.support is ignored when building the index. I'll do that if no better consensus is reached on python-dev soon. ---------- assignee: -> georg.brandl _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Eli Bendersky <eliben@gmail.com> added the comment: Georg, since the issue was originally opened to track the solution, not the problem, I just figured it may be useful to mention that this solution was rejected and close the issue, for better historical record. Otherwise some years from now no one will remember what the debate was and that the solution was overruled in favor of another. It's just an opinion, though. I don't have strong feelings about this. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Changes by Brett Cannon <brett@python.org>: ---------- nosy: -brett.cannon _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Carol Willing added the comment: Reviewed the issue history during the PyCon sprints. Thanks to all for the thoughts on this issue. I am closing this issue since any additional actions on this subject would be best filed as a new issue. ---------- nosy: +willingc resolution: -> out of date status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
Changes by Berker Peksag <berker.peksag@gmail.com>: ---------- stage: patch review -> resolved _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12652> _______________________________________
participants (10)
-
Barry A. Warsaw -
Berker Peksag
-
Brett Cannon
-
Carol Willing
-
Eli Bendersky
-
Ezio Melotti
-
Georg Brandl
-
Nick Coghlan
-
Sandro Tosi
-
Éric Araujo