From e00986f82be37554e0575188f7fe6cf43843cbb2 Mon Sep 17 00:00:00 2001
From: Jason Thompson <jason@jasonthompson.org>
Date: Tue, 23 Jul 2024 11:23:00 -0400
Subject: [PATCH] Adding documentation to give a description to the
 remove_obsidian_comments postprocessor.

---
 src/postprocessors.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/postprocessors.rs b/src/postprocessors.rs
index 157f4b0..b278ae8 100644
--- a/src/postprocessors.rs
+++ b/src/postprocessors.rs
@@ -52,6 +52,8 @@ fn filter_by_tags_(
     }
 }
 
+/// This postprocessor removes all Obsidian comments from a file excluding codeblocks. Enabling this
+/// prohibits comments from being exported but leaves them untouched in the original files
 pub fn remove_obsidian_comments(
     _context: &mut Context,
     events: &mut MarkdownEvents,