Opened 8 years ago

Closed 7 years ago

#6489 defect closed wontfix (wontfix)

lore generates incorrect API links for methods

Reported by: acapnotic Owned by:
Priority: normal Milestone:
Component: lore Keywords:
Cc: Branch:
Author:

Description

An API reference of the form <code class="API" base="twisted.web.client.Response">deliverBody</code> generates a link to twisted.web.client.Response.deliverBody.html, which is not a thing that exists; the location is twisted.web.client.Response.html#deliverBody.

(From #5681.)

lore.tree.fixAPI currently has the big assumption that all API resources are of the form 'STUFF%(api)sTHINGS', which is not accurate for our docs.

fixAPI could take a callable instead of a plain template string that would know if it should turn "foo.Bar.baz" into "foo.Bar.baz.html", ", "foo/Bar.baz.html", or "foo.Bar.html#baz", but that may require some API change to tree.doFile() and munge().

Change History (2)

comment:1 Changed 7 years ago by khorn

Component: corelore

comment:2 Changed 7 years ago by khorn

Resolution: wontfix
Status: newclosed

Lore has been deprecated. Closing.

Note: See TracTickets for help on using tickets.