Adding documentation to give a description to the remove_obsidian_comments postprocessor.

2024-07-23 11:23:00 -04:00 · 2024-07-23 11:23:00 -04:00 · e00986f82b
commit e00986f82b
parent 754c347873
1 changed files with 2 additions and 0 deletions
--- 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,