aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-21 18:21:56 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-21 18:21:56 +0200
commita23cff0886f284f33622bce2bddf42b30d006438 (patch)
tree221e24098c1079b629ce4fc9a23146df4b6807db
parent59ebfca815fc482f624cd3cf1c40c78bd7640623 (diff)
downloadmarkdown-rs-a23cff0886f284f33622bce2bddf42b30d006438.tar.gz
markdown-rs-a23cff0886f284f33622bce2bddf42b30d006438.tar.bz2
markdown-rs-a23cff0886f284f33622bce2bddf42b30d006438.zip
Add docs on virtual space
Diffstat (limited to '')
-rw-r--r--readme.md2
-rw-r--r--src/constant.rs5
2 files changed, 4 insertions, 3 deletions
diff --git a/readme.md b/readme.md
index 1d3cedc..a2c3344 100644
--- a/readme.md
+++ b/readme.md
@@ -68,7 +68,6 @@ cargo doc --document-private-items
#### Docs
-- [ ] (1) Add docs for virtual spaces
- [ ] (1) Add docs to `subtokenize.rs`
- [ ] (1) Add docs for `link.rs`
- [ ] (1) Add docs for token types
@@ -234,6 +233,7 @@ cargo doc --document-private-items
- [x] (1) Configurable tokens (destination, label, title)
- [x] (1) Configurable limit (destination)
- [x] (1) Add docs for `default_line_ending`
+- [x] (1) Add docs for virtual spaces
### Extensions
diff --git a/src/constant.rs b/src/constant.rs
index 6ba1638..90e66d4 100644
--- a/src/constant.rs
+++ b/src/constant.rs
@@ -211,10 +211,11 @@ pub const SAFE_PROTOCOL_SRC: [&str; 2] = ["http", "https"];
/// constructs in markdown, most notable the whitespace required to form
/// [code (indented)][code_indented].
///
-/// <!-- To do: link to somewhere that discusses virtual spaces. -->
-/// <!-- Ref: https://github.com/syntax-tree/mdast-util-to-markdown/issues/51 -->
+/// > 👉 **Note**: each [`Code::VirtualSpace`][vs] and `Code::Char('\t' | ' ')`
+/// > counts.
///
/// [code_indented]: crate::construct::code_indented
+/// [vs]: crate::tokenizer::Code::VirtualSpace
pub const TAB_SIZE: usize = 4;
/// The number of markers needed for a [thematic break][thematic_break] to form.