From 02afa95240e00a6309c5065ea29d2de4cd7d3373 Mon Sep 17 00:00:00 2001
From: "Michael Bradley, Jr." <michaelsbradleyjr@gmail.com>
Date: Sun, 1 Oct 2023 11:09:19 -0500
Subject: [PATCH] update doc comments for cozo_run_query

---
 cozo-lib-c/cozo_c.h   | 15 +++++++--------
 cozo-lib-c/src/lib.rs | 15 +++++++--------
 2 files changed, 14 insertions(+), 16 deletions(-)

diff --git a/cozo-lib-c/cozo_c.h b/cozo-lib-c/cozo_c.h
index 218bad76..ced6056f 100644
--- a/cozo-lib-c/cozo_c.h
+++ b/cozo-lib-c/cozo_c.h
@@ -47,14 +47,13 @@ bool cozo_close_db(int32_t db_id);
 /**
  * Run query against a database.
  *
- * `db_id`: the ID representing the database to run the query.
- * `script_raw`: a UTF-8 encoded C-string for the CozoScript to execute.
- * `params_raw`: a UTF-8 encoded C-string for the params of the query,
- *               in JSON format. You must always pass in a valid JSON map,
- *               even if you do not use params in your query
- *               (pass "{}" in this case).
- * `errored`:    will point to `false` if the query is successful,
- *               `true` if an error occurred.
+ * `db_id`:           the ID representing the database to run the query.
+ * `script_raw`:      a UTF-8 encoded C-string for the CozoScript to execute.
+ * `params_raw`:      a UTF-8 encoded C-string for the params of the query,
+ *                    in JSON format. You must always pass in a valid JSON map,
+ *                    even if you do not use params in your query
+ *                    (pass "{}" in this case).
+ * `immutable_query`: whether the query is read-only.
  *
  * Returns a UTF-8-encoded C-string that **must** be freed with `cozo_free_str`.
  * The string contains the JSON return value of the query.
diff --git a/cozo-lib-c/src/lib.rs b/cozo-lib-c/src/lib.rs
index 922b2055..e34bb351 100644
--- a/cozo-lib-c/src/lib.rs
+++ b/cozo-lib-c/src/lib.rs
@@ -91,14 +91,13 @@ pub unsafe extern "C" fn cozo_close_db(db_id: i32) -> bool {
 
 /// Run query against a database.
 ///
-/// `db_id`: the ID representing the database to run the query.
-/// `script_raw`: a UTF-8 encoded C-string for the CozoScript to execute.
-/// `params_raw`: a UTF-8 encoded C-string for the params of the query,
-///               in JSON format. You must always pass in a valid JSON map,
-///               even if you do not use params in your query
-///               (pass "{}" in this case).
-/// `errored`:    will point to `false` if the query is successful,
-///               `true` if an error occurred.
+/// `db_id`:           the ID representing the database to run the query.
+/// `script_raw`:      a UTF-8 encoded C-string for the CozoScript to execute.
+/// `params_raw`:      a UTF-8 encoded C-string for the params of the query,
+///                    in JSON format. You must always pass in a valid JSON map,
+///                    even if you do not use params in your query
+///                    (pass "{}" in this case).
+/// `immutable_query`: whether the query is read-only.
 ///
 /// Returns a UTF-8-encoded C-string that **must** be freed with `cozo_free_str`.
 /// The string contains the JSON return value of the query.