Ticket #3139 defect closed fixed

Opened 5 years ago

Last modified 4 years ago

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

pb-root-3139.patch Download (0.8 KB) - added by thijs 5 years ago.

Change History

1

Changed 5 years ago by thijs

  • owner changed from glyph to thijs
  • status changed from new to assigned
  • cc thijs added

2

Changed 5 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 5 years ago by thijs

3

Changed 5 years ago by thijs

  • status changed from assigned to new
  • keywords documentation, review added; documentation removed
  • owner thijs deleted

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..

4

Changed 5 years ago by exarkun

  • owner set to radix
  • keywords documentation added; documentation, review removed
  • milestone set to Twisted-8.2

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.

5

Changed 4 years ago by exarkun

  • status changed from new to closed
  • resolution set to fixed

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

6

Changed 4 years ago by exarkun

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

7

Changed 2 years ago by <automation>

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