Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #197104

Re: How to go about describing my software with a component diagram?

Show key headers only | View raw

On 25/12/24 10:05, marc nicole wrote:
 > 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.

On 25/12/24 23:08, marc nicole via Python-list wrote:
> the purpose of the diagram is to convey a minimalistic idea about the
> structure of the code/implementation/software

In which case, and assuming the "algorithm" is the application's script, 
what will the diagram say that is not conveyed by the three import 
statements which (almost) head-up the script?

The difficulty you are presenting to respondents (and to eventual 
readers) is the paucity of information: block-labels, line/arrow labels, 
diagram title, expected reader(s), ...


PS would it be better to keep the conversation to one Discussion List?



> 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
>>

-- 
Regards,
=dn

Back to comp.lang.python | Previous | Next | Find similar

Thread

Re: How to go about describing my software with a component diagram? dn <PythonList@DancesWithMice.info> - 2024-12-26 08:29 +1300

csiph-web