From d0330f05d89c951517fe99f09e58c94d19b48b62 Mon Sep 17 00:00:00 2001
From: Will Boyd <will@codersblock.com>
Date: Mon, 26 Feb 2024 11:20:29 -0500
Subject: [PATCH] Comments about decoding

---
 src/frontmatter/categories.js | 2 +-
 src/frontmatter/coverImage.js | 4 ++--
 src/frontmatter/slug.js       | 2 +-
 src/frontmatter/tags.js       | 2 +-
 src/frontmatter/title.js      | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/frontmatter/categories.js b/src/frontmatter/categories.js
index 82aad78..4408ba6 100644
--- a/src/frontmatter/categories.js
+++ b/src/frontmatter/categories.js
@@ -1,6 +1,6 @@
 const settings = require('../settings');
 
-// get array of categories for post, filtered as specified in settings
+// get array of decoded category names, filtered as specified in settings
 module.exports = (post) => {
 	if (!post.data.category) {
 		return [];
diff --git a/src/frontmatter/coverImage.js b/src/frontmatter/coverImage.js
index a3a6f29..ea63c6b 100644
--- a/src/frontmatter/coverImage.js
+++ b/src/frontmatter/coverImage.js
@@ -1,5 +1,5 @@
-// get cover image filename, previously set on post.meta
-// this one is unique as it relies on logic executed by the parser
+// get cover image filename, previously decoded and set on post.meta
+// this one is unique as it relies on special logic executed by the parser
 module.exports = (post) => {
 	return post.meta.coverImage;
 };
diff --git a/src/frontmatter/slug.js b/src/frontmatter/slug.js
index 47063a9..7664b22 100644
--- a/src/frontmatter/slug.js
+++ b/src/frontmatter/slug.js
@@ -1,4 +1,4 @@
-// get slug, previously set on post.meta
+// get slug, previously decoded and set on post.meta
 module.exports = (post) => {
 	return post.meta.slug;
 };
diff --git a/src/frontmatter/tags.js b/src/frontmatter/tags.js
index 9cb2c28..2781145 100644
--- a/src/frontmatter/tags.js
+++ b/src/frontmatter/tags.js
@@ -1,4 +1,4 @@
-// get array of tags for post
+// get array of decoded tag names
 module.exports = (post) => {
 	if (!post.data.category) {
 		return [];
diff --git a/src/frontmatter/title.js b/src/frontmatter/title.js
index d33e515..b10bd29 100644
--- a/src/frontmatter/title.js
+++ b/src/frontmatter/title.js
@@ -1,4 +1,4 @@
-// get simple post title
+// get simple post title, but not decoded like other frontmatter string fields
 module.exports = (post) => {
 	return post.data.title[0];
 };