Opened 15 years ago

Closed 15 years ago

#1943 enhancement closed fixed (fixed)

better epytext in twisted.application and twisted.conch

Reported by: Michael Hudson-Doyle Owned by:
Priority: normal Milestone:
Component: core Keywords:
Cc: Michael Hudson-Doyle Branch:
Author:

Description

I spend a fair amount of time looking at the result of running Twisted's docstrings through epytext while working on pydoctor. Often, the results aren't that pretty, so I thought I'd be systematic about it. application and conch came first in the alphabet :-)

As well as fixing the odd ropey literal block, changing a lot of C{}s into L{}s and using @param a whole lot more, I fixed a few typos that I saw on my way.

You can see the output at:

http://starship.python.net/crew/mwh/apidocs/twisted.application.html http://starship.python.net/crew/mwh/apidocs/twisted.conch.html

(you need a recent pydoctor for some of the links to work)

Not all the new L{}s in t.c.interfaces work yet, I'm not quite sure how to fix it. One way is demonstrated in the docstring of IConchUser.lookupChannel, but that clutters the text version of the docstring rather).

Attachments (1)

better-epytest-appconch.diff (46.4 KB) - added by Michael Hudson-Doyle 15 years ago.
round 1

Download all attachments as: .zip

Change History (4)

Changed 15 years ago by Michael Hudson-Doyle

round 1

comment:1 Changed 15 years ago by Michael Hudson-Doyle

Cc: Michael Hudson-Doyle added

comment:2 Changed 15 years ago by Jean-Paul Calderone

Resolution: fixed
Status: newclosed

(In [17656]) Apply mwh's epytext cleanup patch

Author: mwh Reviewer: exarkun Fixes #1943

This fixes various errors in the epytext markup in twisted.conch and twisted.application. It also makes changes to correct markup to make it more useful and so that it renders in a more appealing way. Documentation which was not using epytext markup at all has also been converted to use it.

comment:3 Changed 11 years ago by <automation>

Owner: Glyph deleted
Note: See TracTickets for help on using tickets.