From a54d9bd83b6c4998c7f37a59aa4222754718b2ee Mon Sep 17 00:00:00 2001
From: Mitchell Hashimoto <mitchell.hashimoto@gmail.com>
Date: Fri, 1 Apr 2022 19:33:12 -0700
Subject: [PATCH] comments

---
 src/opengl.zig | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/opengl.zig b/src/opengl.zig
index dbd5b39ad..5c7747e17 100644
--- a/src/opengl.zig
+++ b/src/opengl.zig
@@ -1,12 +1,15 @@
 //! OpenGL bindings.
 //!
 //! These are pupose-built for usage within this program. While they closely
-//! align with the OpenGL C APIs, they aren't meant to be general purpose.
-//! Certain use cases will CERTAINLY be sub-optimal by using these helpers
-//! and should use the C API directly.
+//! align with the OpenGL C APIs, they aren't meant to be general purpose,
+//! they aren't meant to have 100% API coverage, and they aren't meant to
+//! be hyper-performant.
 //!
 //! For performance-intensive or unsupported aspects of OpenGL, the C
 //! API is exposed via the `c` constant.
+//!
+//! WARNING: Lots of performance improvements that we can make with Zig
+//! comptime help. I'm deferring this until later but have some fun ideas.
 
 pub const c = @import("opengl/c.zig");
 pub const Buffer = @import("opengl/Buffer.zig");