From 6ab986e2b809a3771370aaad395f2f810a9aac25 Mon Sep 17 00:00:00 2001
From: Mitzi Morris <mitzi212@gmail.com>
Date: Sun, 4 Aug 2024 18:49:24 -0400
Subject: [PATCH] stan_csv_reader - doc comments

---
 src/stan/io/stan_csv_reader.hpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/stan/io/stan_csv_reader.hpp b/src/stan/io/stan_csv_reader.hpp
index 060de317e0..164c45e69b 100644
--- 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
    */