Skip to content

Commit d666372

Browse files
committed
improve model docs
1 parent 81c81f1 commit d666372

File tree

2 files changed

+6
-17
lines changed

2 files changed

+6
-17
lines changed

docs/docs/adding_modules.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,6 @@ modules:
2525
repository: wastewater
2626
```
2727
28-
### Required fields
29-
30-
Each module entry must include:
31-
32-
| Field | Description |
33-
|------------------|----------------------------------------------------------------|
34-
| `name` | Human-readable name shown in the module dropdown. |
35-
| `id` | Short unique identifier for the module. |
36-
| `organisation` | GitHub organization or user that owns the repository. |
37-
| `repository` | GitHub repository name containing the module. |
38-
3928
### ModuleConfig reference
4029
4130
::: oqtopus.core.modules_config.ModuleConfig

oqtopus/core/modules_config.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ class ModuleConfig(BaseModel):
55
"""Configuration for a single module.
66
77
Attributes:
8-
name: Display name of the module.
9-
id: Unique identifier for the module (used for loading).
10-
organisation: GitHub organisation where the module is hosted.
11-
repository: GitHub repository name for the module.
12-
exclude_releases: Optional regex pattern to exclude certain releases.
13-
experimental: Whether this module is experimental (not shown by default).
8+
name: **Required.** Display name of the module.
9+
id: **Required.** Unique identifier for the module (used for loading).
10+
organisation: **Required.** GitHub organisation where the module is hosted.
11+
repository: **Required.** GitHub repository name for the module.
12+
exclude_releases: *Optional.* Regex pattern to exclude certain releases.
13+
experimental: *Optional.* Whether this module is experimental (not shown by default).
1414
"""
1515

1616
name: str

0 commit comments

Comments
 (0)