Mention coverage.py in trace module documentation

[brettcannon]

BPO	29455
Nosy	@brettcannon, @marco-buttu
PRs	bpo-29455: Mention coverage.py in trace module documentation #261 [3.6] bpo-29455: Mention coverage.py in trace module documentation (GH-261) #435
Files	issue29455.patch issue29455_2nd.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/brettcannon'
closed_at = <Date 2017-03-03.21:01:05.644>
created_at = <Date 2017-02-06.03:39:07.705>
labels = ['type-feature', '3.7', 'docs']
title = 'Mention coverage.py in trace module documentation'
updated_at = <Date 2017-03-24.23:02:45.187>
user = 'https://github.com/brettcannon'

bugs.python.org fields:

activity = <Date 2017-03-24.23:02:45.187>
actor = 'brett.cannon'
assignee = 'brett.cannon'
closed = True
closed_date = <Date 2017-03-03.21:01:05.644>
closer = 'brett.cannon'
components = ['Documentation']
creation = <Date 2017-02-06.03:39:07.705>
creator = 'brett.cannon'
dependencies = []
files = ['46538', '46548']
hgrepos = []
issue_num = 29455
keywords = ['patch']
message_count = 7.0
messages = ['287075', '287107', '287159', '287161', '288927', '290323', '290325']
nosy_count = 3.0
nosy_names = ['brett.cannon', 'docs@python', 'marco.buttu']
pr_nums = ['261', '435']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue29455'
versions = ['Python 3.6', 'Python 3.7']

[brettcannon]

In the trace module it would be nice to also mention that coverage.py is available.

[marco-buttu]

I added a "seealso" at the end of the page.

[brettcannon]

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).

[marco-buttu]

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.

[brettcannon]

Thanks for the PR, Marco!

[brettcannon]

New changeset 9d07ace by Brett Cannon in branch '3.6':
bpo-29455: Mention coverage.py in trace module documentation (GH-435)
9d07ace

[brettcannon]

New changeset 5dfccb0 by Brett Cannon (Marco Buttu) in branch 'master':
bpo-29455: Mention coverage.py in trace module documentation (#261)
5dfccb0