[issue32471] Add an UML class diagram to the collections.abc module documentation

[Raymond Hettinger]

Raymond Hettinger  added the comment:

See the rationale in the closed PR.  I rather liked this idea but it didn't 
prove to be a net win during user testing.

--
resolution:  -> rejected
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Yahya Abou Imran]

Yahya Abou Imran  added the comment:

I succeed in submitting a PR and building the doc locally.

But there is a little problem of consistency with the abstract methods:
in some classes, the inherited one are mentioned (Collection, Sequence, 
Mapping), but not in some others (Coroutine, Reversible).

So I don't not what to show and what to hide.

I opened an other issue for this:
https://bugs.python.org/issue32621

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Yahya Abou Imran]

Change by Yahya Abou Imran :


--
keywords: +patch
pull_requests: +4994
stage:  -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Yahya Abou Imran]

Yahya Abou Imran  added the comment:

I have generated SVG files.

Here is the rest of the ABCs present in the module:

https://gitlab.com/yahya-abou-imran/collections-abc-uml/blob/master/plantuml/other_collections.svg

And here is the full version with all ABCs:

https://gitlab.com/yahya-abou-imran/collections-abc-uml/blob/master/plantuml/full.svg

What do you prefer?

I'm gonna submit a PR with the full version right now. I will correct it if you 
think it's too big.

But I don't know how to run the server of the documentation locally, so I can't 
test it to see...

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Ivan Levkivskyi]

Change by Ivan Levkivskyi :


--
nosy: +levkivskyi

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Raymond Hettinger]

Raymond Hettinger  added the comment:

This is a nice looking diagram.  Nice work.  The existing table is great when 
you care about knowing what a particular ABC does, but the diagram nicely gives 
an overview of whole ecosystem all at once.

If the collections.abc module continues its unabated growth, the diagram will 
become a spaghetti bowl.  But for now, it reads nicely.

--
nosy: +rhettinger

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Brett Cannon]

Brett Cannon  added the comment:

I should mention that over on python-ideas people found the open source code to 
plantuml, so I think the format is acceptable for use in the docs.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Brett Cannon]

Brett Cannon  added the comment:

I brought this up on python-ideas, but I think discussing it here may be 
better: I think we may need to use a data file format that has an open source 
implementation. The tool Yahya used (plantuml) doesn't appear to be open 
source, which is a problem for the long-term maintainability of the diagram. If 
I'm wrong about open source tools for reading .puml files to generate SVG files 
then my worries are alleviated, but if there aren't any then something like a 
dot file may be better long-term.

--
nosy: +brett.cannon

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Yahya Abou Imran]

Yahya Abou Imran  added the comment:

Here is the .puml

--
Added file: https://bugs.python.org/file47358/base.puml

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32471] Add an UML class diagram to the collections.abc module documentation

[Yahya Abou Imran]

New submission from Yahya Abou Imran :

>From python-ideas: 
>https://mail.python.org/pipermail/python-ideas/2017-December/048492.html

In this page of the documentation:
https://docs.python.org/3/library/collections.abc.html

The table could be difficult to understand, a diagram help visualize things.

I'm joining the last version of my work, and the .puml I used to generate it.

Opinions about details (fonts, displaying...) are being discussed on the 
mailist right now.

--
assignee: docs@python
components: Documentation
files: base.png
messages: 309318
nosy: docs@python, yahya-abou-imran
priority: normal
severity: normal
status: open
title: Add an UML class diagram to the collections.abc module documentation
type: enhancement
versions: Python 3.6, Python 3.7
Added file: https://bugs.python.org/file47357/base.png

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com