Skip to content

Commit ad9db08

Browse files
committed
📝 Refactor class diagrams and update SVG representations
- Updated class definitions in `classes_my_module01.html` to reflect changes in type annotations and class relationships. - Modified the class hierarchy in `classes_my_module01.svg`, including the addition of `MyClassCliConfig` and its relationship to `MyClassConfigPM`. - Adjusted the layout and dimensions of the SVG to improve clarity and presentation. - Enhanced the package diagram in `packages_my_module01.html` to include the `__main__` class and its connections to other classes. - Updated the corresponding SVG and PDF files to reflect the latest changes in the diagrams.
1 parent 6216e4c commit ad9db08

File tree

9 files changed

+101
-81
lines changed

9 files changed

+101
-81
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ exclude: |
1818
| site/
1919
| site-packages/
2020
| node_modules/
21+
| docs/diagrams/
2122
| logs/
2223
)$
2324

docs/diagrams/classes/classes_my_module01.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,26 @@
44
<div class="mermaid">
55

66
classDiagram
7-
class ExtraBaseModel {
8-
model_config : ConfigDict
9-
}
107
class MyClass {
118
config
129
items
13-
run(items: Union[List[float], None], threshold: Union[float, None]) List[float]
10+
run(items: list[float] | None, threshold: float | None) list[float]
11+
}
12+
class MyClassCliConfig {
13+
items : Optional[list[float]]
14+
model_config : SettingsConfigDict
15+
settings_customise_sources(settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) tuple[PydanticBaseSettingsSource, ...]
1416
}
1517
class MyClassConfigPM {
1618
max_length : Optional[int]
1719
max_value : Optional[float]
1820
min_length : Optional[int]
1921
min_value : Optional[float]
22+
model_config : ConfigDict
2023
threshold : Optional[float]
2124
}
22-
MyClassConfigPM --|> ExtraBaseModel
25+
MyClassCliConfig --|> MyClassConfigPM
2326
MyClassConfigPM --* MyClass : config
24-
MyClassConfigPM --* MyClass : __config
2527

2628
</div>
2729
</body>
-94 Bytes
Binary file not shown.
16.3 KB
Loading
Lines changed: 41 additions & 46 deletions
Loading

docs/diagrams/packages/packages_my_module01.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
classDiagram
77
class my_module01 {
88
}
9+
class __main__ {
10+
}
911
class __version__ {
1012
}
1113
class _base {
@@ -17,6 +19,8 @@
1719
my_module01 --> __version__
1820
my_module01 --> _base
1921
my_module01 --> config
22+
__main__ --> _base
23+
__main__ --> config
2024
_base --> __version__
2125
_base --> config
2226

227 Bytes
Binary file not shown.
5.02 KB
Loading
Lines changed: 47 additions & 29 deletions
Loading

0 commit comments

Comments
 (0)