From 782833341d0e59ac435a296b03f9c240ae03ec72 Mon Sep 17 00:00:00 2001
From: Vincent Rischmann
Date: Mon, 9 Aug 2021 21:41:39 +0200
Subject: clarify Mode documentation

---
 sqlite.zig | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'sqlite.zig')

diff --git a/sqlite.zig b/sqlite.zig
index b0f3216..8fd536b 100644
--- a/sqlite.zig
+++ b/sqlite.zig
@@ -291,6 +291,10 @@ pub const Db = struct {
     db: *c.sqlite3,
 
     /// Mode determines how the database will be opened.
+    ///
+    /// * File means opening the database at this path with sqlite3_open_v2.
+    /// * Memory means opening the database in memory.
+    ///   This works by opening the :memory: path with sqlite3_open_v2 with the flag SQLITE_OPEN_MEMORY.
     pub const Mode = union(enum) {
         File: [:0]const u8,
         Memory,
-- 
cgit v1.2.3