Groups > comp.lang.python > #197092

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	dn <PythonList@DancesWithMice.info>
Newsgroups	comp.lang.python
Subject	Re: How to go about describing my software with a component diagram?
Date	Wed, 25 Dec 2024 09:49:03 +1300
Organization	DWM
Lines	14
Message-ID	<mailman.20.1735073349.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> <fec9932c-40fc-49e9-8ba3-ae20561118df@DancesWithMice.info>
Mime-Version	1.0
Content-Type	text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding	7bit
X-Trace	news.uni-berlin.de wUL906CxPVouAm1me9u0UgO6sOMWqkukaj7EPCYGMguQ==
Cancel-Lock	sha1:vXjrvVPGcpUbHeJYk/0TiRr4Wuc= sha256:vICdjfzEmZ2s2M0vzVhA7jT+Be93TVTVHz6Y/TRcuxw=
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=XYDPQtNM; dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status	OK 0.105
X-Spam-Level	*
X-Spam-Evidence	'H': 0.79; 'S': 0.00; '=dn': 0.09; 'from:addr:danceswithmice.info': 0.09; 'from:addr:pythonlist': 0.09; 'devs': 0.16; 'diagram': 0.16; 'message- id:@DancesWithMice.info': 0.16; 'received:cloud': 0.16; 'received:rangi.cloud': 0.16; 'wrote:': 0.16; 'to:addr:python- list': 0.20; 'header:User-Agent:1': 0.30; 'subject:How': 0.31; 'mailing': 0.31; 'am,': 0.31; 'python-list': 0.32; 'header:Organization:1': 0.32; 'header:In-Reply-To:1': 0.34; 'url:)': 0.35; 'received:192.168': 0.37; 'list': 0.39; 'use': 0.39; 'url-ip:185.199.108.153/32': 0.39; 'url-ip:185.199.108/24': 0.39; 'url-ip:185.199/16': 0.39; 'michael': 0.60; 'including': 0.60; 'here': 0.63; 'skip:b 10': 0.63; 'attachments,': 0.64; 'tool': 0.65; 'technical': 0.67; 'attached': 0.68; 'markdown': 0.84; 'url:js': 0.93
DKIM-Filter	OpenDKIM Filter v2.11.0 vps.rangi.cloud 5C05D5A71
DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/simple; d=danceswithmice.info; s=staff; t=1735073346; bh=pvJ4XIc1LEQrMFjcoXv8NGmNlhVFYr+3voIYDhZGXCQ=; h=Date:From:Subject:To:References:In-Reply-To:From; b=XYDPQtNMk6BhSd6oLkJX6jq/n2gfmFhcAuPvyrpTJYIQZBfSzi9U9XuIQktYz+nVA tdgEhCi/yOSgOMNB1VFipp0ju2DP1Jw5X9kt8L75O81rwEU48CC9RDgbTH6QJnvAHG 2OnMheibTZVsFlfqTftMTijwECwbwf4PL0SqVnaFrt2+XX45jZJR30TcN/nNliTSHY dCT9ZkDH9Bd7YKQn/DCb0W5igZu0P6Gs9hAw+UqLYJ8RhwrIIobdRygW6wH3EzCqnk qPDmc68jniPHNlgX8PIhRiGsopTimPp3rnXlHP76SdFS32lOJKeyROXmvIUanjYWRa 6Znj1veYHuXYA==
User-Agent	Mozilla Thunderbird
Content-Language	en-US
In-Reply-To	<a7e5db71-ec6e-2625-a257-352303ff5e8a@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	<fec9932c-40fc-49e9-8ba3-ae20561118df@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>
Xref	csiph.com comp.lang.python:197092

Show key headers only | View raw

On 25/12/24 08:00, Michael Torrie via Python-list wrote:
> 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.

Many devs use Markdown (or similar) text-only file-formats for technical 
documentation. A tool for including block-graphics in these is "Mermaid" 
(https://mermaid.js.org/intro/).

-- 
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-25 09:49 +1300

csiph-web