stan_csv_reader - doc comments

stan-dev · Aug 4, 2024 · 6ab986e · 6ab986e
1 parent db6eb32
commit 6ab986e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/stan/io/stan_csv_reader.hpp b/src/stan/io/stan_csv_reader.hpp
@@ -349,6 +349,11 @@ class stan_csv_reader {
   /**
    * Parses the file.
    *
+   * Warns if missing metatdata, inconsistencies between metadata config
+   * and parsed data rows.
+   *
+   * Throws exception if no header row found.
+   *
    * @param[in] in input stream to parse
    * @param[out] out output stream to send messages
    */