Use proper class markup for random.Random docs

[ncoghlan]

BPO	33783
Nosy	@rhettinger, @mdickinson, @ncoghlan, @vstinner, @berkerpeksag
PRs	bpo-33783: Use proper class markup for random.Random docs #7817 [3.7] bpo-33783: Use proper class markup for random.Random docs (GHè7817) #12859

^{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/rhettinger'
closed_at = <Date 2019-04-16.21:37:27.675>
created_at = <Date 2018-06-06.14:22:42.798>
labels = ['easy', '3.8', 'type-feature', '3.7', 'docs']
title = 'Use proper class markup for random.Random docs'
updated_at = <Date 2019-04-16.21:37:27.673>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2019-04-16.21:37:27.673>
actor = 'vstinner'
assignee = 'rhettinger'
closed = True
closed_date = <Date 2019-04-16.21:37:27.675>
closer = 'vstinner'
components = ['Documentation']
creation = <Date 2018-06-06.14:22:42.798>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 33783
keywords = ['patch', 'easy']
message_count = 5.0
messages = ['318827', '318871', '340356', '340367', '340368']
nosy_count = 5.0
nosy_names = ['rhettinger', 'mark.dickinson', 'ncoghlan', 'vstinner', 'berker.peksag']
pr_nums = ['7817', '12859']
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33783'
versions = ['Python 3.7', 'Python 3.8']

[ncoghlan]

Talking to Berker on http://psf.upfronthosting.co.za/roundup/meta/issue644 I noticed that docs for random.Random are currently embedded in the module preamble text for https://docs.python.org/3/library/random.html and hence really easy to miss.

It would be good if they were broken out into a proper Sphix class directive so that the fact you can create your own dedicated pseudorandom number generators for specific purposes is easier to see on a quick scan of the docs.

[rhettinger]

Thanks, I'll add a separate entry for the random.Random() class.

[vstinner]

New changeset 31e8d69 by Victor Stinner (Matthias Bussonnier) in branch 'master':
bpo-33783: Use proper class markup for random.Random docs (GHè7817)
31e8d69

[vstinner]

New changeset a6fce19 by Victor Stinner (Miss Islington (bot)) in branch '3.7':
bpo-33783: Use proper class markup for random.Random docs (GH-7817) (GH-12859)
a6fce19

[vstinner]

I pushed Matthias's change. Thanks Matthias!

I am not sure that it implements exactly what Nick asked. Reopen the issue if it is not the case.