Skip to content

Commit 1bc9ad7

Browse files
committed
docs: added class docstrings to ModelFileRegistry.
1 parent 4763ece commit 1bc9ad7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

floatcsep/infrastructure/registries.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,14 @@ def factory(
167167

168168

169169
class ModelFileRegistry(ModelRegistry, FilepathMixin):
170+
"""
171+
The class is responsible to handle the keys (in this case filepaths) to access model objects
172+
such as forecasts, input catalogs or argument/parameter files. These keys are used mainly by
173+
:class:`floatcsep.infrastructure.repositories.ForecastRepository` or
174+
:class:`floatcsep.infrastructure.repositories.CatalogRepository`.
175+
176+
"""
177+
170178
def __init__(
171179
self,
172180
model_name: str,

0 commit comments

Comments
 (0)