Opened 9 years ago

Closed 8 years ago

#4624 enhancement closed fixed (fixed)

win32eventreactor docstring should link to the Process docstring it mentions.

Reported by: Screwtape Owned by: Screwtape
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch: branches/link-to-Process-docs-4624
branch-diff, diff-cov, branch-cov, buildbot
Author: screwtape

Description

The win32eventreactor docstring says "Process running has some problems (see Process docstring)." but it doesn't link to the Process docstring in question. It's not at all obvious which Process is being referred to without source-diving.

Change History (7)

comment:1 Changed 9 years ago by screwtape

Author: screwtape
Branch: branches/link-to-Process-docs-4624

(In [29909]) Create branch link-to-Process-docs-4624

comment:2 Changed 9 years ago by screwtape

(In [29910]) Link to Process docs.

Refs: #4624

comment:3 Changed 9 years ago by screwtape

(In [29911]) Link to Process docs.

Refs: #4624

comment:4 Changed 9 years ago by screwtape

(In [29912]) Revert r29910

Didn't mean to commit this to trunk, sorry. :(

Refs: #4624

comment:5 Changed 9 years ago by Screwtape

Keywords: review added
Owner: Glyph deleted

OK, I accidentally committed this to trunk in r29910, but I reverted it in r29912. In that brief time however, builders were triggered and the resulting API docs look good to me.

r29911 is the same change, committed on the branch.

comment:6 Changed 9 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to Screwtape

Needs a 4624.misc, otherwise looks good.

comment:7 Changed 8 years ago by Jean-Paul Calderone

Resolution: fixed
Status: newclosed

(In [31654]) Merge link-to-Process-docs-4624

Author: Screwtape Reviewer: exarkun Fixes: #4624

Add an API doc link from the win32eventreactor module docstring to the primary process-support implementation class.

Note: See TracTickets for help on using tickets.