chore(metadata): Update docstrings

openclimatefix · Dec 17, 2024 · ea80153 · ea80153
1 parent abe151e
commit ea80153
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/src/nwp_consumer/internal/entities/modelmetadata.py b/src/nwp_consumer/internal/entities/modelmetadata.py
@@ -1,3 +1,16 @@
+"""Domain classes for Models and their metadata.
+
+Sources of NWP data have attributes both pertaining to and apart from
+the data they deliver. This module defines classes for metadata that
+tracks relevant information about the model repository and the data
+it provides. This might be helpful in determining the quality of the
+data, defining pipelines for processing, or establishing the availability
+for a live service.
+
+In this instance, the `ModelMetadata` refers to information pertaining
+to the model used to generate the data itself.
+"""
+
 import dataclasses
 import logging
 

diff --git a/src/nwp_consumer/internal/entities/repometadata.py b/src/nwp_consumer/internal/entities/repometadata.py
@@ -7,10 +7,8 @@
 data, defining pipelines for processing, or establishing the availability
 for a live service.
 
-In this instance, the `ModelMetadata` refers to information pertaining
-to the model used to generate the data itself, whilst the
-`ModelRepositoryMetadata` refers to information about the repository
-where NWP data produced by the model resides.
+In this instance, the `ModelRepositoryMetadata` refers to information
+about the repository where NWP data produced by the model resides.
 """
 
 import dataclasses