Opened 5 years ago

Closed 5 years ago

#6309 enhancement closed fixed (fixed)

getProcessOutput doc string should use proper epydoc instead of *this*

Reported by: Hynek Schlawack Owned by: Tom Prince
Priority: lowest Milestone:
Component: core Keywords: documentation
Cc: Hynek Schlawack Branch: branches/getProcessOutput-epytext-6309
branch-diff, diff-cov, branch-cov, buildbot
Author: hynek

Description

This one is a bit OCD, but it caught my eye: twisted.internet.utils.getProcessOutput has the following sentence inside of its doc string:

The first string should *NOT* be the executable's name.

I think a B{NOT} would be more appropriate.

Attachments (1)

getProcessOutput-use-proper-epydoc.patch (564 bytes) - added by Hynek Schlawack 5 years ago.

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by Hynek Schlawack

comment:1 Changed 5 years ago by Hynek Schlawack

Cc: Hynek Schlawack added
Keywords: review added

comment:2 Changed 5 years ago by Tom Prince

Author: tomprince
Branch: branches/getProcessOutput-epytext-6309

(In [37156]) Branching to getProcessOutput-epytext-6309.

comment:3 Changed 5 years ago by Tom Prince

Author: tomprincehynek
Keywords: review removed
Owner: set to Tom Prince

This looks good, and the documentation and twistedchecker builder like.

Merging.

comment:4 Changed 5 years ago by Tom Prince

Resolution: fixed
Status: newclosed

(In [37159]) Merge getProcessOutput-epytext-6309: getProcessOutput doc string should use proper epydoc instead of *this*

Author: hynek Reviewers: tom.prince Fixes: #6309

This one is a bit OCD, but it caught my eye: twisted.internet.utils.getProcessOutput has the following sentence inside of its doc string:

The first string should *NOT* be the executable's name.

I think a B{NOT} would be more appropriate.

Note: See TracTickets for help on using tickets.