Groups > comp.lang.python > #197099

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

Path	csiph.com!fu-berlin.de!uni-berlin.de!not-for-mail
From	marc nicole <mk1853387@gmail.com>
Newsgroups	comp.lang.python
Subject	Re: How to go about describing my software with a component diagram?
Date	Wed, 25 Dec 2024 11:08:30 +0100
Lines	28
Message-ID	<mailman.27.1735121240.2912.python-list@python.org> (permalink)
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>
Mime-Version	1.0
Content-Type	text/plain; charset="UTF-8"
Content-Transfer-Encoding	quoted-printable
X-Trace	news.uni-berlin.de +5zmY8qA4cQ3298qtcA4uwauISmjRH5pZv7Rob2TB19Q==
Cancel-Lock	sha1:2S0RcQJirJChvK1xC50X9ECrroM= sha256:/nGLoYlruhWMkgTzpScohYMALYHmEE8yRT3pYdZ9I/8=
Return-Path	<mk1853387@gmail.com>
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=gmail.com header.i=@gmail.com header.b=aMJ1CeR2; dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status	OK 0.016
X-Spam-Evidence	'H': 0.97; 'S': 0.00; 'is.': 0.05; 'else.': 0.07; 'url:mailman': 0.09; '"an': 0.09; 'cc:addr:python-list': 0.09; 'computing': 0.09; 'email addr:python.org>': 0.09; '>': 0.14; 'cc:no real name:20': 0.14; 'url:listinfo': 0.15; 'diagram': 0.16; 'implements': 0.16; 'labeled': 0.16; 'preferably': 0.16; 'things,': 0.16; 'viewer': 0.16; 'wrote:': 0.16; "can't": 0.17; 'pm,': 0.19; 'cc:addr:python.org': 0.20; 'url- ip:188.166.95.178/32': 0.20; 'url-ip:188.166.95/24': 0.20; 'lines': 0.23; 'url-ip:188.166/16': 0.24; 'idea': 0.24; 'cc:20': 0.25; 'library': 0.26; 'visual': 0.26; 'purpose': 0.28; 'sense': 0.28; 'thinking': 0.28; 'email addr:python.org>': 0.28; 'subject:How': 0.31; 'module': 0.31; 'message-id:@mail.gmail.com': 0.31; 'nature': 0.32; 'python-list': 0.32; 'structure': 0.32; 'header:In-Reply-To:1': 0.34; 'received:google.com': 0.34; 'mean': 0.34; 'from:addr:gmail.com': 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; '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; 'url:net': 0.67; '"a': 0.76; 'cooperate': 0.84; 'difference.': 0.84; 'email name:<python-list': 0.84; '\xc3\xa9crit\xc2\xa0:': 0.84; 'convey': 0.91; 'me:': 0.91; 'url:i': 0.97
DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1735121237; x=1735726037; darn=python.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=mMwPH3JtFkLXTxUTa+Tl1ABWqx8Pww2WiyvNYmiAL4c=; b=aMJ1CeR2b+hyhh53ixi8rVQWmGmkvBlyBzT9YsevFoRVlY3Mc5lrXEpm0lXgKf9tHp 63I/EN/y/488UxPvxK7oKsCzavrE4l5gFpTh8FermEw0Q0nANM+UzStTNbWeL0VF0DEE FqaPPzw+38FXvXhBRanByXcYPIwnCQcnToHHKeT7kQyp9dJsRhNKWn/GBV5Txe3CQwGn vqLszHO1vQN3BVCQSC0oprSSDGc5IDp8/5nfeDsvcWQKrtLfotWV4EhXH546QY+ISLSR gy1bxBXMj9YxWgCiKFpSARHD9q+MYeIe07IWtUQOryOkDEvCbEwk984gSNxMrhEiEYeu jubw==
X-Google-DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1735121237; x=1735726037; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=mMwPH3JtFkLXTxUTa+Tl1ABWqx8Pww2WiyvNYmiAL4c=; b=Y65erJxydr6ScsC4ABrmNpGzwDxEvWlnH8he5E+WO/+8WyIAqceWSwP5I7jgMzi8/W a3vwo/MxuLupCycWCCJa+aCumPvtxfn7NHcIzBfcnXmoz6SxmQEjRlxo/CbwYFArH0Vf I/2XfDumEytG1k4CNqKebIcnwV/tR/rOdDFQ3arRhhaH4EJcY3PB4/zZ+FmpXxkrq7x0 m47XfxqBWk7oSobqn93qj8ve+6Si6p+eTVaVCHaG9rdda/EDg5Lb7zGpcIutwxT4PX3T DIvH1pVzx38/OABcKVU29XbCCOzrNV0fLRiRI1qm5QOrmDTQlk8fKJp3/REzoT+XEVAX Jr6g==
X-Forwarded-Encrypted	i=1; AJvYcCVZuFI9VEKegLLHaebHmFiVGXVw+jnmKYKMPOYgEL4CnI5IRg7itcLacazrLs3BkapXdTyMPg==@python.org
X-Gm-Message-State	AOJu0YzQTvEKjm8pGVzqAJFIgHXcKf3GcbhRDjs7ZGyOySD/1KvCmVwt QM3SaILyVHhJnfksC0Rifx+UwOQXlQzKtWqRLM+NTmQRj+YZtRDk7CeeZmdS+lxro1regaF3ZP6 5xFTPS3V5J2Aip/OZd9FCDfQ073Yxjtos
X-Gm-Gg	ASbGnctnJbMIDdWN7EIDr9wqlFXrqlhWtTwWKkTqTEdyMXg6qj+Qcu/RdotiyWz6aqU XnU/4h7aJjW9jpXh5+URDm9XsIvE03b6WfJ1qHg==
X-Google-Smtp-Source	AGHT+IHzVXllxrFC/vw78JV44VdzTHTB0uULbTdw1+v0oSU9CyossGg26yrrkYFdVHnZzwFr6r/WIYU+p1TTq4lqzl4=
X-Received	by 2002:a05:6902:11cf:b0:e39:87f0:7074 with SMTP id 3f1490d57ef6-e538c350cd3mr12817334276.35.1735121236970; Wed, 25 Dec 2024 02:07:16 -0800 (PST)
In-Reply-To	<0c3c9d66-39a2-491c-9e86-9c9cd6df814a@tompassin.net>
X-Content-Filtered-By	Mailman/MimeDel 2.1.39
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	<CAGJtH9QR8awV2fJuP9niU0MBRAg9snGshVBxv=ZSgJ7omi+UZw@mail.gmail.com>
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>
Xref	csiph.com comp.lang.python:197099

Show key headers only | View raw

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
>

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

Thread

Re: How to go about describing my software with a component diagram? marc nicole <mk1853387@gmail.com> - 2024-12-25 11:08 +0100

csiph-web