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

Groups > comp.lang.python > #197096

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

Show key headers only | View raw

On 12/24/2024 4:08 PM, marc nicole via Python-list wrote:
> The full python package (pypi) being represented as the outermost frame
> here including the 4 sub-frames)
> 
> Le mar. 24 déc. 2024 à 22:05, marc nicole <mk1853387@gmail.com> a écrit :
> 
>> 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.

As is, the diagram doesn't convey any of that.  For example, main.py is 
a program, not an algorithm. we can't tell that main.py imports three 
modules.  They might just as well be internal classes.  If you want to 
communicate something you need to say or show what that thing is.

This might be close to what you have said (I only show 2 of the 3 
modules and I didn't have the page width for the bottom left-hand label) -

                      ------------
                      |  main.py | --implements--> Agorithm A
                      ------------
	               /        \
                      imports  imports
                        |         |
                        ↓         ↓
                    ---------   --------
                    | V.py  |   | S.py | --implements--> Subalgorithm A.2
                    ---------   --------

>> Le mar. 24 déc. 2024 à 21:56, dn via Python-list <python-list@python.org>
>> a écrit :
>>
>>> On 25/12/24 06:27, marc nicole via Python-list wrote:
>>>> Hello community,
>>>>
>>>> I have created a Python code where a main algorithm uses three different
>>>> modules (.py) after importing them.
>>>>
>>>> To illustrate and describe it I have created the following component
>>>> diagram?
>>>>
>>>>
>>>> [image: checkso.PNG]
>>>>
>>>> Could it be improved for better description and readability?
>>>
>>>
>>> Possibly - so little detail as to topic and any hints in the diagram
>>> redacted! What messages do you want to communicate with this diagram?
>>>
>>> Given that the three modules are subordinate contributors to the
>>> script/algorithm, place the three modules inside a larger "Algorithm"
>>> shape.
>>>
>>> --
>>> Regards,
>>> =dn
>>> --
>>> 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? Thomas Passin <list1@tompassin.net> - 2024-12-24 16:44 -0500

csiph-web