From 6456529b7f0e9973bc58fd38a102ea133018ff0e Mon Sep 17 00:00:00 2001
From: Kevin FEDYNA <fedyna.kevin@gmail.com>
Date: Wed, 22 Jan 2025 14:48:00 +0100
Subject: [PATCH] Added documentation for connect file

---
 databases/connect.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/databases/connect.ts b/databases/connect.ts
index 7836dcd..1a6bbdc 100644
--- a/databases/connect.ts
+++ b/databases/connect.ts
@@ -4,6 +4,11 @@ interface DatabaseConnection extends Disposable {
   database: Database;
 }
 
+/**
+ * Connect to the given database and attach `students.db`.
+ * @param database The database name.
+ * @returns The database connection as disposable.
+ */
 export default function connect(database: string): DatabaseConnection {
   const connection = new Database(`databases/data/${database}.db`, {
     create: false,