document raw node a little more.

Remove redundant "plain" output mode; to be added (and tested) if needed.
kivikakk · Dec 17, 2024 · 6f5ca7d · 6f5ca7d
1 parent 04eedf6
commit 6f5ca7d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 4 deletions.
diff --git a/src/html.rs b/src/html.rs
@@ -380,9 +380,6 @@ where
                             | NodeValue::HtmlInline(ref literal) => {
                                 self.escape(literal.as_bytes())?;
                             }
-                            NodeValue::Raw(ref literal) => {
-                                self.output.write_all(literal.as_bytes())?;
-                            }
                             NodeValue::LineBreak | NodeValue::SoftBreak => {
                                 self.output.write_all(b" ")?;
                             }

diff --git a/src/nodes.rs b/src/nodes.rs
@@ -127,7 +127,8 @@ pub enum NodeValue {
     /// **Inline**.  [Raw HTML](https://github.github.com/gfm/#raw-html) contained inline.
     HtmlInline(String),
 
-    /// **Inline**.  A Raw text.
+    /// **Block/Inline**.  A Raw output node. This will be inserted verbatim into CommonMark and
+    /// HTML output. It can only be created programmatically, and is never parsed from input.
     Raw(String),
 
     /// **Inline**.  [Emphasized](https://github.github.com/gfm/#emphasis-and-strong-emphasis)