[Python-ideas] Add an UML class diagram to the collections.abc module documentation

Brett Cannon brett at python.org
Tue Jan 2 14:38:40 EST 2018

On Tue, 2 Jan 2018 at 05:25 Yahya Abou 'Imran <
yahya-abou-imran at protonmail.com> wrote:

> At the end of the day, I found that plantuml is the most suitable tool for
> this.

Right, but when I look at http://plantuml.com/ I don't see any open source
code to guarantee it will be available in e.g. 5 years. (I really just see
a lot of ads around a free Java app).

> Graphviz dot is interesting, but it doesn't feel natural to make class
> diagram with it, or at least it's less handy... I could bring several
> arguments to support this, but it's not the topic.

It's somewhat the topic to me, though, since people seem to have found the
diagrams helpful, which means defining how to sustainably maintain them so
we are willing to accept them into the documentation is important as that
will be the next step in accepting them into the documentation.

> Everybody wanting to try itself is welcome, but, *I* can take the
> commitment to maintain it over the years.

I personally appreciate that offer, but I also don't know you well enough
to be able to take that as a guarantee, hence why I'm trying to make sure
the tooling that is used will last for a very long time (next month will be
the 27th anniversary of Python's first public release, so anything we do
may need to last a while :) .

I know this is an annoying thing to be thinking about when you already have
the diagram done in plantuml, but sustaining this work for a long time is
part of maintaining open source.


> Here are the 3 svg files witch are my last proposals for the moment:
> https://gitlab.com/yahya-abou-imran/collections-abc-uml/blob/master/plantuml/base.svg
> https://gitlab.com/yahya-abou-imran/collections-abc-uml/blob/master/plantuml/other_collections.svg
> https://gitlab.com/yahya-abou-imran/collections-abc-uml/blob/master/plantuml/full.svg
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-ideas/attachments/20180102/4886a8f1/attachment.html>

More information about the Python-ideas mailing list