Skip to content

Commit b3cf104

Browse files
committed
Add docstring to key of history and summary observations
1 parent ccb66d2 commit b3cf104

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

src/ert/config/_observations.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ class HistoryObservation(ObservationError):
4141

4242
@property
4343
def key(self) -> str:
44+
"""The :term:`summary key` to be fetched from :ref:`refcase`."""
45+
# For history observations the key is also the name, ie.
46+
# "HISTORY_OBSERVATION FOPR" means to add the values from
47+
# the summary vector FOPRH in refcase as observations.
4448
return self.name
4549

4650
@classmethod
@@ -85,7 +89,7 @@ class ObservationDate:
8589
class _SummaryValues:
8690
name: str
8791
value: float
88-
key: str
92+
key: str #: The :term:`summary key` in the summary response
8993

9094

9195
@dataclass

0 commit comments

Comments
 (0)