Opened 7 years ago

Closed 6 years ago

Last modified 6 years ago

#3139 defect closed fixed (fixed)

Broken link to pb.Root and friends in pb-usage documentation

Reported by: glyph Owned by:
Priority: normal Milestone: Twisted-8.2
Component: core Keywords: documentation
Cc: thijs Branch:
Author: Launchpad Bug:

Description

It seems like all the API documentation links on the web site are broken right now, but even if that issue were fixed, pb-usage.html either has the wrong class names for the things it's linking to or the links don't work.

See the original report of this problem in #38; we now have the tools to fix it in any way we want.

Attachments (1)

pb-root-3139.patch (837 bytes) - added by thijs 6 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 6 years ago by thijs

  • Cc thijs added
  • Owner changed from glyph to thijs
  • Status changed from new to assigned

comment:2 Changed 6 years ago by glyph

Thank you, thank you, thank you for taking this ticket away from me. Please tell everyone else to steal tickets from me too :-).

Changed 6 years ago by thijs

comment:3 Changed 6 years ago by thijs

  • Keywords review added
  • Owner thijs deleted
  • Status changed from assigned to new

I added a patch that points the baseclass to the actual baseclass, twisted.spread.flavors in this case, but I'm not sure if this is the way to go, since we lose the reference to 'pb.Root' with just 'Root' instead. Let me know how to approach this with the 'tools' from #38..

comment:4 Changed 6 years ago by exarkun

  • Keywords review removed
  • Milestone set to Twisted-8.2
  • Owner set to radix

Hmm. I wonder why the link is still broken. I thought we resolved #38 in time for the last release.

I just regenerated the API documentation and twisted.spread.pb.Root.html exists now. So I think this will be resolved (automagically) when we regenerate the API docs (which will happen for the next release), without any changes to pb-usage.xhtml.

comment:5 Changed 6 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

8.2 released, new docs generated and on the site, the links work now.

comment:6 Changed 6 years ago by exarkun

  • Milestone changed from Twisted-8.2+1 to Twisted-8.2

comment:7 Changed 4 years ago by <automation>

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