Ticket #1712 (new defect )

Opened 3 years ago

Last modified 8 months ago

Twisted overview graph shows Xish

Reported by: ralphm Assigned to: radix
Type: defect Priority: normal
Milestone: Component: core
Keywords: documentation Cc: exarkun, thijs
Branch: branches/overview-graph-1712 Author: thijs
Launchpad Bug:

Description

The graphical overview at http://twistedmatrix.com/projects/core/documentation/howto/overview.html still shows Xish as a separate component. However, it has been folder into Words a while back.

Attachments

Change History

  2006-05-12 14:01:29+00:00 changed by exarkun

  • keywords set to documentation
  • owner changed from glyph to tekNico

follow-up: ↓ 4   2006-05-12 14:03:07+00:00 changed by exarkun

It also shows Twisted.Flow, Twisted.Protocols as containing all the protocol implementations, half the executables in the wrong place, and implies "String ports" is a fundamental part of core twisted. Basically half this picture is wrong. The whole thing needs a going over.

  2006-05-13 20:05:54+00:00 changed by ralphm

  • cc set to exarkun

Would 2.3 be a good target for this?

in reply to: ↑ 2   2008-07-09 20:52:24+00:00 changed by thijs

  • cc changed from exarkun to exarkun, thijs
  • branch deleted
  • author deleted

Replying to exarkun:

Basically half this picture is wrong. The whole thing needs a going over.

Are the source files for those diagrams available?

  2008-07-09 20:57:39+00:00 changed by exarkun

There's doc/core/img/twisted-overview.dia, that's probably it.

  2008-11-09 19:59:41+00:00 changed by thijs

  • owner changed from tekNico to thijs
  • status changed from new to assigned
  • launchpad_bug deleted

  2008-11-10 20:24:56+00:00 changed by thijs

  • branch set to branches/overview-graph-1712
  • branch_author set to thijs

(In [25338]) Branching to 'overview-graph-1712'

  2008-11-10 20:34:46+00:00 changed by thijs

  • keywords changed from documentation to documentation, review
  • owner deleted
  • status changed from assigned to new

Removed xish and flow from the diagram in r25339, I'll need a better description/suggestion to restructure the diagram. Putting it up for review.

  2008-11-13 09:25:05+00:00 changed by ralphm

Your change indeed fixes the problem described in this ticket. Is your question whether this diagram should have more changes? I think so. Should it go into this ticket? I'd agree on widening the scope of this ticket.

  2008-11-19 16:56:17+00:00 changed by exarkun

  • keywords changed from documentation, review to documentation
  • owner set to radix

Yes. The diagram still needs a lot of work. Even with xish in the right place now, it doesn't really convey useful information to someone trying to learn about Twisted. It's just a bunch of boxes and words and arrows.

We could remove it entirely or someone who's familiar with the various abstractions in Twisted could try fixing it (perhaps by starting over from scratch) to be useful.

A couple other specific problems with the current form:

  • it includes mktap, which we've stopped documenting anywhere else
  • it talks about bin/lore instead of bin/lore/lore

There are doubtless other issues, but those are the two which I noticed first. Even if these are fixed, the diagram is still not useful (but the problems shouldn't be replicated in any future version).

As a roughly orthogonal issue, dia doesn't seem like the best format we could use for this kind of thing. I'd suggest svg for a future version (but whatever).

Speculatively reassigning this to someone who might fall into the familiar with the various abstractions in Twisted group.

Note: See TracTickets for help on using tickets.