adapting documentation for new domain_labels

GAMS-dev · Mar 27, 2023 · 6e00286 · 6e00286
1 parent 72f2a7e
commit 6e00286
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/doc/records.dox b/doc/records.dox
@@ -57,8 +57,7 @@ format.
   `scale` for \ref GAMSTransfer::Variable "Variable" and \ref
   GAMSTransfer::Equation "Equation") and the records as rows. In case of
   `struct`, the columns are given as struct fields. The column names for domain
-  entry columns are the domain name postfixed with their dimension. These
-  expected names are also given by \ref GAMSTransfer::Symbol::domain_labels
+  entry columns can be shown and altered by \ref GAMSTransfer::Symbol::domain_labels
   "Symbol.domain_labels".
 
   For example, `x` in \ref GAMSTRANSFER_MATLAB_GETSTARTED_EXAMPLE as `table`:

diff --git a/src/Symbol.m b/src/Symbol.m
@@ -71,9 +71,15 @@
         domain
 
 
-        %> Expected domain labels in records.
+        %> Domain labels in records.
+        %>
+        %> Domain labels mirror the field/column names for domains in records. They only exist for
+        %> \ref GAMSTRANSFER_MATLAB_RECORDS_FORMAT "formats" table and struct. Setting domain labels
+        %> may modify the given labels to make them unique by adding _<dim>. * is changed to uni.
 
-        % domain_labels Expected domain labels in records. 
+        % domain_labels Domain labels mirror the field/column names for domains in records. They
+        % only exist for formats table and struct. Setting domain labels may modify the given labels
+        % to make them unique by adding _<dim>. * is changed to uni.
         domain_labels
     end