Skip to content

docs: add mermaid diagrams #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
faif merged 7 commits into from
Mar 13, 2026
Merged

docs: add mermaid diagrams #469

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
964f3f2
docs: add mermaid diagrams
maxkrivachev-web Mar 4, 2026
f393fbd
Update README.md
maxkrivachev-web Mar 6, 2026
cf4fd6d
docs: add mermaid diagrams
maxkrivachev-web Mar 9, 2026
d40a423
docs: add mermaid diagrams
maxkrivachev-web Mar 9, 2026
f311afd
docs: add mermaid diagrams
maxkrivachev-web Mar 9, 2026
ce1cef0
docs: add mermaid diagrams
maxkrivachev-web Mar 9, 2026
f44674f
docs: add mermaid diagrams
maxkrivachev-web Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
@maxkrivachev-web
maxkrivachev-web authored Mar 6, 2026
commit f393fbd63ff021687b0ed3a74292b34a7e613689
55 changes: 2 additions & 53 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
# README.md — вставки с диаграммами Mermaid
# python-patterns

> Ниже показаны **три блока**, которые нужно вставить в `README.md` перед таблицей каждого раздела.
> Каждый блок отделён от окружающего текста пустой строкой (требование GitHub Markdown renderer).
A collection of design patterns and idioms in Python.

---

## 🔵 Вставка 1 — перед таблицей **Creational Patterns**

Место: сразу после строки `## Creational Patterns` и перед строкой `| Pattern | Description |`

```markdown
## Creational Patterns

> Patterns that deal with **object creation** — abstracting and controlling how instances are made.
Expand All @@ -25,23 +17,6 @@ graph LR

FactoryMethod -->|subclass decides| ConcreteProduct
Pool -->|reuses| PooledInstance
```

| Pattern | Description |
```

---

## 🟢 Вставка 2 — перед таблицей **Structural Patterns**

Место: сразу после строки `## Structural Patterns` и перед строкой `| Pattern | Description |`

```markdown
## Structural Patterns

> Patterns that define **how classes and objects are composed** to form larger, flexible structures.

```mermaid
graph TD
Client --> Facade
Facade --> SubsystemA
Expand All @@ -57,23 +32,6 @@ graph TD
Component --> Composite
Composite --> Leaf1
Composite --> Leaf2
```

| Pattern | Description |
```

---

## 🟠 Вставка 3 — перед таблицей **Behavioral Patterns**

Место: сразу после строки `## Behavioral Patterns` и перед строкой `| Pattern | Description |`

```markdown
## Behavioral Patterns

> Patterns concerned with **communication and responsibility** between objects.

```mermaid
graph LR
Sender -->|sends event| Observer1
Sender -->|sends event| Observer2
Expand All @@ -87,12 +45,3 @@ graph LR

Originator -->|saves state to| Memento
Caretaker -->|holds| Memento
```

| Pattern | Description |
```

---

> **Примечание для ревьюеров:** диаграммы намеренно упрощены — цель показать *ключевое взаимодействие* каждой группы, а не полную UML-схему каждого паттерна. Детали реализации — в `.py`-файлах.

Loading