Rocksolid Light

News from da outaworlds

mail  files  register  groups  login

Message-ID:  

BOFH excuse #447: According to Microsoft, it's by design


comp / comp.lang.python / Re: How to go about describing my software with a component diagram?

SubjectAuthor
o Re: How to go about describing my software with a component diagram?Thomas Passin

1
Subject: Re: How to go about describing my software with a component diagram?
From: Thomas Passin
Newsgroups: comp.lang.python
Date: Tue, 24 Dec 2024 21:18 UTC
References: 1 2 3 4 5
Path: eternal-september.org!news.eternal-september.org!feeder3.eternal-september.org!fu-berlin.de!uni-berlin.de!not-for-mail
From: list1@tompassin.net (Thomas Passin)
Newsgroups: comp.lang.python
Subject: Re: How to go about describing my software with a component diagram?
Date: Tue, 24 Dec 2024 16:18:54 -0500
Lines: 19
Message-ID: <mailman.26.1735087601.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>
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
X-Trace: news.uni-berlin.de oxdpfdsymndBblDoceES8gOpN/peLOA/fAjNettsEDKg==
Cancel-Lock: sha1:XJExkq/7+2MJyHCy6PVDBIXIJns= sha256:RgMwXb5uwHND9hhgaDzT/yF7hwmS36r0nqn2EXNeQ+A=
Return-Path: <list1@tompassin.net>
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=tompassin.net header.i=@tompassin.net header.b=Kl+zzpiy;
dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status: OK 0.015
X-Spam-Evidence: '*H*': 0.97; '*S*': 0.00; 'is.': 0.05; 'else.': 0.07;
'"an': 0.09; 'computing': 0.09; 'received:23.83.212': 0.09;
'received:elm.relay.mailchannels.net': 0.09; 'diagram': 0.16;
'implements': 0.16; 'labeled': 0.16; 'preferably': 0.16;
'received:10.0.0': 0.16; 'received:64.90': 0.16;
'received:64.90.62': 0.16; 'received:64.90.62.162': 0.16;
'received:dreamhost.com': 0.16; 'things,': 0.16; 'viewer': 0.16;
'wrote:': 0.16; "can't": 0.17; 'pm,': 0.19; 'to:addr:python-list':
0.20; 'lines': 0.23; 'library': 0.26; 'visual': 0.26; 'purpose':
0.28; 'sense': 0.28; 'thinking': 0.28; 'header:User-Agent:1':
0.30; 'subject:How': 0.31; 'module': 0.31; 'nature': 0.32;
'python-list': 0.32; 'received:10.0': 0.32;
'received:mailchannels.net': 0.32;
'received:relay.mailchannels.net': 0.32; 'header:In-Reply-To:1':
0.34; 'mean': 0.34; '"the': 0.35; "it's": 0.37; 'could': 0.37;
'url-ip:104.18.41/24': 0.39; 'url-ip:172.64.146/24': 0.39;
'otherwise': 0.39; 'received:100': 0.39; 'something': 0.40;
'should': 0.40; 'tell': 0.60; 'connection': 0.61; 'here': 0.63;
'imagine': 0.64; 'box': 0.65; 'look': 0.65; 'url:png': 0.66;
'header:Received:6': 0.67; 'url:net': 0.67; 'received:64': 0.68;
'cooperate': 0.84; 'difference.': 0.84; 'me:': 0.91; 'url:i': 0.97
X-Sender-Id: dreamhost|x-authsender|tpassin@tompassin.net
ARC-Seal: i=1; s=arc-2022; d=mailchannels.net; t=1735075136; a=rsa-sha256;
cv=none;
b=LDsKQprzOoooktA/xlb8I4c6QFMx09q8dntuF3iiqTOf/l0lRLf5l7pQtNDWqw61bqPlQb
7eaYJAK8OrJwSMSbcxzLPzZPJf5BfD0jfO0FN4c8BlEY1sVXoqRJCjHZ9a93SgFe1/YgKL
J+H22EXgWQ1m0dE+ZDcc4evtbDrz+ZxWgCHK7uc1iibC6dsyD1yh31Dxqx+M4zEFvim5xm
PoDyZHcnK6MZw27wVWl7CKkr6kgbPPyLJQAqWlBrP3fsEDnUuG70xH+ggVSFvbD508vfvq
QZZvKkJ2Fmip9kBhhy+TW/8HVxTLjANcZM9DMsPnSkBLrPVIA33P5iWK2zkJvA==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed;
d=mailchannels.net; s=arc-2022; t=1735075136;
h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
to:to:cc:mime-version:mime-version:content-type:content-type:
content-transfer-encoding:content-transfer-encoding:
in-reply-to:in-reply-to:references:references:dkim-signature;
bh=q3xQ6kgD80AryAhmUHMTYSQuPpaCIylrtZGdSChGo4c=;
b=ESsAitRj67C5BxdFEgeeF1KxLhm2ob91L520wC730LSHEQp8gXTLjN3OT1VF6o0Az6l553
RiS8l+FH2geAC7bAvmUvJOez3n61H2VI3thTg4g4/0RLIJlOHMFshBmV83cA4ovrthAcYZ
c7c1470cnb2RM+zq9M2NmebjBO8sj9g7t9w7luZj69CDz3lEUbZFiscWKy1ue4jvdLvjdb
eHLKd+knTO8renczMn0Ao9/svYEA4Rs+066vxcy+14FPNd103DmrIWw0/X93iNewEmXhTZ
ussT9otf7YHOsLB98ekRsjOJNtz/0FM5R+6mHj1LF8sMv79QscEU57Mgow5wGA==
ARC-Authentication-Results: i=1; rspamd-56bf78cbd4-bvkhw;
auth=pass smtp.auth=dreamhost smtp.mailfrom=list1@tompassin.net
X-Sender-Id: dreamhost|x-authsender|tpassin@tompassin.net
X-MC-Relay: Neutral
X-MailChannels-SenderId: dreamhost|x-authsender|tpassin@tompassin.net
X-MailChannels-Auth-Id: dreamhost
X-Whimsical-Quick: 2343daa10c906435_1735075137005_780006351
X-MC-Loop-Signature: 1735075137005:439327440
X-MC-Ingress-Time: 1735075137005
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tompassin.net;
s=dreamhost; t=1735075136;
bh=q3xQ6kgD80AryAhmUHMTYSQuPpaCIylrtZGdSChGo4c=;
h=Date:Subject:To:From:Content-Type:Content-Transfer-Encoding;
b=Kl+zzpiyB9nMjh8aKsTLS4Oaf4OxNHR6E0FE3fM3Zg6q9yb5qz7tGdN1ZeoKO2cVt
iNMR/Kotq+y4NDT9o/5rSduJeTW8ggereiHs2AtIpvhs6VibXxAN9fyXTUVgO9MOQZ
Oy7ovIgBSmRBOzqpyA8txaxtiPlXyTb5qdne+UnlIWQcxqXgoOO+YVFRd4FlURnRuQ
4N60pjjyreLzjosV+nWqUa9uUBOTEVbFmBquS03brH4fYghYudJqLE6sivUj/WLtIf
bTTJnBDsAMh9YprpC6baX9Qwrya1TGxBO10LzvMKgraZT+hROZIakJFSqDpN5cfJNI
qVXXWU3BU5/HQ==
User-Agent: Mozilla Thunderbird
Content-Language: en-US
In-Reply-To: <CAGJtH9QyXW64qnB2sSz8ZSp8x+dsyEH-_PvSmmTN1dR-wbPEQQ@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: <0c3c9d66-39a2-491c-9e86-9c9cd6df814a@tompassin.net>
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>
View all headers

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.

1

rocksolid light 0.9.8
clearnet tor