From de896901bb3e1f88da73ced63657dd7e952d9719 Mon Sep 17 00:00:00 2001
From: h7x4 <h7x4@nani.wtf>
Date: Mon, 8 Dec 2025 21:41:36 +0900
Subject: [PATCH] models/Base: add comment about `__repr__` impl

---
 dibbler/models/Base.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/dibbler/models/Base.py b/dibbler/models/Base.py
index f48fb10..e0bcc3d 100644
--- a/dibbler/models/Base.py
+++ b/dibbler/models/Base.py
@@ -29,6 +29,10 @@ class Base(DeclarativeBase):
     def __tablename__(cls) -> str:
         return _pascal_case_to_snake_case(cls.__name__)
 
+    # NOTE: This is the default implementation of __repr__ for all tables,
+    #       but it is preferable to override it for each table to get a nicer
+    #       looking representation. This trades a bit of messiness for a complete
+    #       output of all relevant fields.
     def __repr__(self) -> str:
         columns = ", ".join(
             f"{k}={repr(v)}"