From fbca98482821347d9e8b4dd7143eaef6299365af Mon Sep 17 00:00:00 2001 From: belthlemar Date: Tue, 18 Jun 2024 17:03:20 +0200 Subject: [PATCH] docs(filesystem): add little doc --- .../model/filesystem/common/area_matrix_list.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/antarest/study/storage/rawstudy/model/filesystem/common/area_matrix_list.py b/antarest/study/storage/rawstudy/model/filesystem/common/area_matrix_list.py index 6ce91bd7ca..8bc1b5a497 100644 --- a/antarest/study/storage/rawstudy/model/filesystem/common/area_matrix_list.py +++ b/antarest/study/storage/rawstudy/model/filesystem/common/area_matrix_list.py @@ -136,6 +136,21 @@ def build(self) -> TREE: class AreaMultipleMatrixList(FolderNode): + """ + Node representing a folder structure containing multiple matrix files for each area. + + Example of tree structure: + + .. code-block:: text + + ts-numbers/thermal + ├── at + │ ├── cluster_gas.txt + │ └── cluster2_gas.txt + └── be + └── cluster_nuclear.txt + """ + def __init__( self, context: ContextServer,