Update comment

atas · Oct 15, 2023 · 9ecc16b · 9ecc16b
1 parent 8991fcf
commit 9ecc16b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/system/cachingUtils.php b/system/cachingUtils.php
@@ -20,6 +20,10 @@ function findMostRecentlyUpdatedFile($dir) {
 /*
  * TODO: This function needs refactoring, should be a class, and needs tests.
  * It can also be used for caching individual .md files.
+ *
+ * This function reads the posts directory to generate posts.json file
+ * This way we are not compiling every .md file to read its meta data (front matter)
+ * If any post's last modified time is newer than the cached posts.json file, it will be updated
  * @return Post[]
  */
 function updateAndGetCachedPostList(): array