From bc890ed5b0898445c998ec62fb89188afefb61ec Mon Sep 17 00:00:00 2001
From: Robin van Dijk <robin@robinjint.nl>
Date: Tue, 6 Oct 2020 16:34:09 +0200
Subject: add doc describing limited capabilities

---
 crates/ide/src/markdown_remove.rs | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'crates/ide')

diff --git a/crates/ide/src/markdown_remove.rs b/crates/ide/src/markdown_remove.rs
index 405d08d8e..ea12cf0fc 100644
--- a/crates/ide/src/markdown_remove.rs
+++ b/crates/ide/src/markdown_remove.rs
@@ -3,6 +3,8 @@
 use pulldown_cmark::{Event, Parser};
 
 /// Removes all markdown, keeping the text and code blocks
+///
+/// Currently limited in styling, i.e. no ascii tables or lists
 pub fn remove_markdown(markdown: &str) -> String {
     let mut out = String::new();
     let parser = Parser::new(markdown);
-- 
cgit v1.2.3