jpt/doodles-py
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

improve readme

Browse Source
This commit is contained in:
James Turk 2024-04-26 16:13:10 -05:00
parent cf9341e3ef
commit a5e66cf68b
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -32,7 +32,7 @@ This application is meant to create small animations/sketches.
`main.py` contains the core application code, but is the least relevant to the design. `main.py` contains the core application code, but is the least relevant to the design.
```mermaidjs ```mermaid
erDiagram erDiagram
Doodle ||--o| Doodle : parent Doodle ||--o| Doodle : parent
Group ||--o{ Doodle : has-many Group ||--o{ Doodle : has-many
@ -105,7 +105,7 @@ implementation, and then adding their own random elements.
(See `lines.py random` for a bit more discussion of this.) (See `lines.py random` for a bit more discussion of this.)
*Liskov Substitution* ### Liskov Substitution
Anywhere that the underlying code expects a `Drawable` it should be possible Anywhere that the underlying code expects a `Drawable` it should be possible
to substitute any child class `Line`, `Rectangle`, etc. to substitute any child class `Line`, `Rectangle`, etc.
@ -113,7 +113,7 @@ to substitute any child class `Line`, `Rectangle`, etc.
This is ensured by having all of them define a common `draw` interface, and having This is ensured by having all of them define a common `draw` interface, and having
their constructors not take dozens of additional parameters. (See `Line.__init__`.) their constructors not take dozens of additional parameters. (See `Line.__init__`.)
*Interface Segregation* ### Interface Segregation
This is largely given by counter-example, the principle here states that we must not force child classes to implement methods they do not use. This is largely given by counter-example, the principle here states that we must not force child classes to implement methods they do not use.
@ -122,7 +122,7 @@ A counter-example to this would be if the pre-render, then draw dance that compl
One could imagine having placed this logic at the `Doodle` class instead of `Line`. One could imagine having placed this logic at the `Doodle` class instead of `Line`.
That would mean that `Circle`, `Rectangle`, etc. would need to implement a (likely empty) method to fulfill this. That would mean that `Circle`, `Rectangle`, etc. would need to implement a (likely empty) method to fulfill this.
*Dependency Inversion* ### Dependency Inversion
Entities should depend on abstractions, not concrete implementations. Entities should depend on abstractions, not concrete implementations.