Sysop: | Amessyroom |
---|---|
Location: | Fayetteville, NC |
Users: | 43 |
Nodes: | 6 (0 / 6) |
Uptime: | 103:36:10 |
Calls: | 290 |
Files: | 905 |
Messages: | 76,595 |
Could it be improved for better description and readability?
On 12/24/24 10:27 AM, marc nicole via Python-list wrote:
the diagram is also attached here
This text-only mailing list does not allow attachments, just FYI.
Hello community,
I have created a Python code where a main algorithm uses three different modules (.py) after importing them.
To illustrate and describe it I have created the following component
diagram?
[image: checkso.PNG]
Could it be improved for better description and readability?
The full python package (pypi) being represented as the outermost frame
here including the 4 sub-frames)
Le mar. 24 déc. 2024 à 22:05, marc nicole <mk1853387@gmail.com> a écrit :
I want to convey the idea that main.py (main algorithm) imports 3 modules (V, S, M) (each of them containing .py scripts related torelate
different functionalities) and use their methods accordingly as per the requirement: basically the structure of my code and how the modules
to each other.
Le mar. 24 déc. 2024 à 21:56, dn via Python-list <python-list@python.org
a écrit :
differentOn 25/12/24 06:27, marc nicole via Python-list wrote:
Hello community,
I have created a Python code where a main algorithm uses three
modules (.py) after importing them.
To illustrate and describe it I have created the following component
diagram?
[image: checkso.PNG]
Could it be improved for better description and readability?
Possibly - so little detail as to topic and any hints in the diagram
redacted! What messages do you want to communicate with this diagram?
Given that the three modules are subordinate contributors to the
script/algorithm, place the three modules inside a larger "Algorithm"
shape.
--
Regards,
=dn
--
https://mail.python.org/mailman/listinfo/python-list
--
https://mail.python.org/mailman/listinfo/python-list
The full python package (pypi) being represented as the outermost frame
here including the 4 sub-frames)
Le mar. 24 déc. 2024 à 22:05, marc nicole <mk1853387@gmail.com> a écrit :
I want to convey the idea that main.py (main algorithm) imports 3 modules
(V, S, M) (each of them containing .py scripts related to
different functionalities) and use their methods accordingly as per the
requirement: basically the structure of my code and how the modules relate >> to each other.
Le mar. 24 déc. 2024 à 21:56, dn via Python-list <python-list@python.org> >> a écrit :
On 25/12/24 06:27, marc nicole via Python-list wrote:
Hello community,
I have created a Python code where a main algorithm uses three different >>>> modules (.py) after importing them.
To illustrate and describe it I have created the following component
diagram?
[image: checkso.PNG]
Could it be improved for better description and readability?
Possibly - so little detail as to topic and any hints in the diagram
redacted! What messages do you want to communicate with this diagram?
Given that the three modules are subordinate contributors to the
script/algorithm, place the three modules inside a larger "Algorithm"
shape.
--
Regards,
=dn
--
https://mail.python.org/mailman/listinfo/python-list
it is here https://i.sstatic.net/ykk5Wd0w.png
I want to convey the idea that main.py (main algorithm) imports 3
modules (V, S, M) (each of them containing .py scripts related to
different functionalities) and use their methods accordingly as per the requirement: basically the structure of my code and how the modules
relate to each other.
the purpose of the diagram is to convey a minimalistic idea about the structure of the code/implementation/software
Le mer. 25 déc. 2024 à 01:49, Thomas Passin via Python-list < python-list@python.org> a écrit :
On 12/24/2024 3:42 PM, marc nicole via Python-list wrote:
it is here https://i.sstatic.net/ykk5Wd0w.png
This diagram does not make much sense to me:
1. What is the purpose of the diagram and who is it intended for?
2. A module and an algorithm are different kinds of things, yet they are
connected together as if they are the same.
3. Connecting lines should always be labeled, preferably with direction
indicators that augment the labels. Otherwise the viewer has to imagine
what the nature of the connection is.
4. It's better if different kinds of things look different. That could
be a different box shape, a different color, or some other visual
difference. Here I am thinking about the box labeled "Algorithm". We
can't tell if it is intended to mean "A library module that implements a
certain algorithm", "An algorithm that the three components cooperate to
implement", "The top-level module for computing an algorithm that
contains three modules", or something else.
--
https://mail.python.org/mailman/listinfo/python-list