Path: ...!news.nobody.at!news.swapon.de!fu-berlin.de!uni-berlin.de!not-for-mail
From: dn <PythonList@DancesWithMice.info>
Newsgroups: comp.lang.python
Subject: Re: How to go about describing my software with a component diagram?
Date: Thu, 26 Dec 2024 08:29:53 +1300
Organization: DWM
Lines: 53
Message-ID: <mailman.30.1735155000.2912.python-list@python.org>
References: <CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com>
 <CAGJtH9STnx2krCYs=6rEMNnc5kHNity-sWZiKWqbuMweRHejVA@mail.gmail.com>
 <a7e5db71-ec6e-2625-a257-352303ff5e8a@gmail.com>
 <CAGJtH9QyXW64qnB2sSz8ZSp8x+dsyEH-_PvSmmTN1dR-wbPEQQ@mail.gmail.com>
 <0c3c9d66-39a2-491c-9e86-9c9cd6df814a@tompassin.net>
 <CAGJtH9QR8awV2fJuP9niU0MBRAg9snGshVBxv=ZSgJ7omi+UZw@mail.gmail.com>
 <0a94d6aa-b034-4e61-85ac-8e3eecc0323e@DancesWithMice.info>
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
X-Trace: news.uni-berlin.de YpV9Meh22ghvyX1vMTWUhA72Z+ayri7TchUGRAr26yEA==
Cancel-Lock: sha1:Es239Zq5j+kS7Sq85lATVNveQYo= sha256:YUB28r1/JzxJQ9LYBaf0qFlpDFqEd3s5YC7aG8Xx0Pg=
Return-Path: <PythonList@DancesWithMice.info>
X-Original-To: python-list@python.org
Delivered-To: python-list@mail.python.org
Authentication-Results: mail.python.org; dkim=pass
 reason="2048-bit key; unprotected key"
 header.d=danceswithmice.info header.i=@danceswithmice.info
 header.b=LiLkyIuH; dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status: OK 0.001
X-Spam-Evidence: '*H*': 1.00; '*S*': 0.00; 'containing': 0.05; 'is.':
 0.05; 'else.': 0.07; 'modules': 0.07; 'url:mailman': 0.09; '"an':
 0.09; '=dn': 0.09; 'computing': 0.09; 'difficulty': 0.09; 'email
 addr:python.org>': 0.09; 'from:addr:danceswithmice.info': 0.09;
 'from:addr:pythonlist': 0.09; 'other.': 0.09; 'import': 0.15;
 'url:listinfo': 0.15; '.py': 0.16; 'accordingly': 0.16;
 'assuming': 0.16; 'diagram': 0.16; 'implements': 0.16; 'labeled':
 0.16; 'message-id:@DancesWithMice.info': 0.16; 'preferably': 0.16;
 'received:cloud': 0.16; 'received:rangi.cloud': 0.16; 'script,':
 0.16; 'things,': 0.16; 'viewer': 0.16; 'wrote:': 0.16; "can't":
 0.17; 'pm,': 0.19; 'to:addr:python-list': 0.20; 'url-
 ip:188.166.95.178/32': 0.20; 'url-ip:188.166.95/24': 0.20;
 'basically': 0.22; 'lines': 0.23; 'code': 0.23; 'url-
 ip:188.166/16': 0.24; 'idea': 0.24; '(and': 0.25; 'discussion':
 0.25; 'library': 0.26; 'visual': 0.26; '>>>': 0.28; 'purpose':
 0.28; 'sense': 0.28; 'thinking': 0.28; 'header:User-Agent:1':
 0.30; 'subject:How': 0.31; 'module': 0.31; 'conversation': 0.32;
 'nature': 0.32; 'python-list': 0.32; 'structure': 0.32;
 'header:Organization:1': 0.32; 'header:In-Reply-To:1': 0.34;
 'mean': 0.34; '"the': 0.35; '...': 0.37; "it's": 0.37; 'could':
 0.37; 'received:192.168': 0.37; 'use': 0.39; 'url-
 ip:104.18.41/24': 0.39; 'url-ip:172.64.146/24': 0.39; 'otherwise':
 0.39; 'methods': 0.39; 'something': 0.40; 'want': 0.40; 'should':
 0.40; 'tell': 0.60; 'connection': 0.61; 'here': 0.63; 'skip:b 10':
 0.63; 'imagine': 0.64; 'information:': 0.64; 'box': 0.65; 'look':
 0.65; 'url:png': 0.66; 'url:net': 0.67; 'per': 0.68; 'presenting':
 0.69; 'relate': 0.69; 'cooperate': 0.84; 'difference.': 0.84;
 'imports': 0.84; 'convey': 0.91; 'me:': 0.91; 'url:i': 0.97
DKIM-Filter: OpenDKIM Filter v2.11.0 vps.rangi.cloud 374224A0C
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=danceswithmice.info;
 s=staff; t=1735154998;
 bh=sWlomrO/CkI9krR+FkDjDmDoQBfcMP0Rn7HlgCh4cHA=;
 h=Date:From:Subject:To:References:In-Reply-To:From;
 b=LiLkyIuH2EyruPohyLC0n91Wd7WN2B4GiV2JO0fdVx17HEGdPNYHIHdaJL3Ah7UH0
 20jeXfMht/S6EaLlOJYsLl86Z3Q7iWiWxHW4EOmogeMzONfGrtsqAvCW+4yllJyDFa
 /I6wAmNMgyF3D55gVPjuDLVhJEueM+NXkFtDKowJ1lqSAkS0p9Ya8XTdLwG9w35VfC
 qOdKd2qntT2cQwBeWYILgd2KHvjLxaeIpuSC5ebpBHdR/czY66qwTbCulBCqLKVb4A
 FFKO62TRccZcBYllgaFzBO6OHmvRWkkBxFch3FO3t3qvFcuv1UFNom9bER268SSonz
 VM3jybbFv48zw==
User-Agent: Mozilla Thunderbird
Content-Language: en-US
In-Reply-To: <CAGJtH9QR8awV2fJuP9niU0MBRAg9snGshVBxv=ZSgJ7omi+UZw@mail.gmail.com>
X-BeenThere: python-list@python.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: General discussion list for the Python programming language
 <python-list.python.org>
List-Unsubscribe: <https://mail.python.org/mailman/options/python-list>,
 <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive: <https://mail.python.org/pipermail/python-list/>
List-Post: <mailto:python-list@python.org>
List-Help: <mailto:python-list-request@python.org?subject=help>
List-Subscribe: <https://mail.python.org/mailman/listinfo/python-list>,
 <mailto:python-list-request@python.org?subject=subscribe>
X-Mailman-Original-Message-ID: <0a94d6aa-b034-4e61-85ac-8e3eecc0323e@DancesWithMice.info>
X-Mailman-Original-References: <CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com>
 <CAGJtH9STnx2krCYs=6rEMNnc5kHNity-sWZiKWqbuMweRHejVA@mail.gmail.com>
 <a7e5db71-ec6e-2625-a257-352303ff5e8a@gmail.com>
 <CAGJtH9QyXW64qnB2sSz8ZSp8x+dsyEH-_PvSmmTN1dR-wbPEQQ@mail.gmail.com>
 <0c3c9d66-39a2-491c-9e86-9c9cd6df814a@tompassin.net>
 <CAGJtH9QR8awV2fJuP9niU0MBRAg9snGshVBxv=ZSgJ7omi+UZw@mail.gmail.com>
Bytes: 7483

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