From e64013f03b2b74fa07a9da896230b180c62e4099 Mon Sep 17 00:00:00 2001
From: kayomn <kayomn@kayomn.net>
Date: Sun, 19 Feb 2023 14:24:17 +0000
Subject: [PATCH] Add missing note to core::path::begin

---
 source/core/files.cpp | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/source/core/files.cpp b/source/core/files.cpp
index e71ab67..42cdd54 100644
--- a/source/core/files.cpp
+++ b/source/core/files.cpp
@@ -29,6 +29,8 @@ export namespace core {
 
 		/**
 		 * Returns the base pointer of the path name.
+		 *
+		 * *Note*: the returned buffer pointer is guaranteed to end with a zero terminator.
 		 */
 		char const * begin() const {
 			return reinterpret_cast<char const *>(this->buffer);