[issue29455] Mention coverage.py in trace module documentation

New submission from Brett Cannon: In the trace module it would be nice to also mention that coverage.py is available. ---------- assignee: docs@python components: Documentation messages: 287075 nosy: brett.cannon, docs@python priority: normal severity: normal status: open title: Mention coverage.py in trace module documentation type: enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Marco Buttu added the comment: I added a "seealso" at the end of the page. ---------- keywords: +patch nosy: +marco.buttu Added file: http://bugs.python.org/file46538/issue29455.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Brett Cannon added the comment: Thanks for the patch, Marco! Typically we put the mention at the top to give the 3rd-party library a better chance of being noticed (see the urllib.request docs to see how requests is mentioned). ---------- assignee: docs@python -> brett.cannon _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Marco Buttu added the comment: Thank you Brett, here is another patch. I added the seealso directive right after the introduction of the trace module, in the same way as urllib.request does for requests. ---------- Added file: http://bugs.python.org/file46548/issue29455_2nd.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Changes by Marco Buttu <marco.buttu@gmail.com>: ---------- pull_requests: +233 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Changes by Berker Peksag <berker.peksag@gmail.com>: ---------- stage: -> patch review versions: +Python 3.6, Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Changes by Brett Cannon <brett@python.org>: ---------- pull_requests: +361 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Brett Cannon added the comment: Thanks for the PR, Marco! ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Brett Cannon added the comment: New changeset 9d07aceedabcdc9826489f8b9baffff056283bb3 by Brett Cannon in branch '3.6': bpo-29455: Mention coverage.py in trace module documentation (GH-435) https://github.com/python/cpython/commit/9d07aceedabcdc9826489f8b9baffff0562... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

Brett Cannon added the comment: New changeset 5dfccb06dc513ae67fac5fee66356ad58a4de170 by Brett Cannon (Marco Buttu) in branch 'master': bpo-29455: Mention coverage.py in trace module documentation (#261) https://github.com/python/cpython/commit/5dfccb06dc513ae67fac5fee66356ad58a4... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________
participants (3)
-
Berker Peksag
-
Brett Cannon
-
Marco Buttu