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

[Victor Stinner]

Hi,

There is "blockdiag" which is Sphinx friendly:
http://blockdiag.com/en/blockdiag/sphinxcontrib.html

Look also at:

* http://asciiflow.com/
* http://ditaa.sourceforge.net/
* http://asciidoctor.org/news/2014/02/18/plain-text-diagrams-in-asciidoctor/
* etc.

I like ASCII Art since it doesn't require any specific tool to edit it
(even if dedicated tools like asciiflow can make editing simpler).

For example, I have no idea how to open a ".puml" file. What if the
tool for this specific format becomes outdated or is not available on
some platforms?

Graphviz with "dot" files is another option.

Victor

2018-01-01 21:39 GMT+01:00 Brett Cannon <brett at python.org>:
> While I appreciate what you're trying to accomplish, Yahya, one thing I
> would like to say is if we were to accept the diagram into the docs I would
> prefer that there be a source file that isn't an image which we can update
> with easily available software (e.g. like a dot file). Otherwise updating
> the file will either be burdensome going forward or we will simply have to
> drop the image at the first instance of needing to update it because no one
> can or be willing to put in the effort (and I'm thinking in 5 years, not
> soon while we can count on you to help).
>
> On Sat, Dec 30, 2017, 08:12 Yahya Abou 'Imran via Python-ideas,
> <python-ideas at python.org> wrote:
>>
>> We can find very usefull class diagramm to understand the hierarchy of the
>> builtin Collection abstract class and interface in java.
>>
>> Some examples:
>> http://www.falkhausen.de/Java-8/java.util/Collection-Hierarchy-simple.html
>> http://www.falkhausen.de/Java-8/java.util/Collection-List.html
>>
>> But when I search about python's ABC, The more detailed I can find are
>> those from the book of Luciano Ramalho Fluent Python:
>> https://goo.gl/images/8JGjvM
>> https://goo.gl/images/6xZqcA
>>
>> (I think they're done with pyreverse of pylint)
>>
>> They are fine, but I think we could provide some other more detailed in
>> this page:
>> https://docs.python.org/3/library/collections.abc.html
>>
>> The table could be difficult to understand, a diagram help visualize
>> things.
>>
>> I've began working on it with plantuml and pyreverse, I'm joining to this
>> mail what I've done so far so you can tell me what you think.
>> _______________________________________________
>> Python-ideas mailing list
>> Python-ideas at python.org
>> https://mail.python.org/mailman/listinfo/python-ideas
>> Code of Conduct: http://python.org/psf/codeofconduct/
>
>
> _______________________________________________
> Python-ideas mailing list
> Python-ideas at python.org
> https://mail.python.org/mailman/listinfo/python-ideas
> Code of Conduct: http://python.org/psf/codeofconduct/
>