aboutsummaryrefslogtreecommitdiffstats
path: root/src/construct/code_fenced.rs
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-13 15:41:26 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-13 15:41:26 +0200
commit06b4ff3531874c95ec07b8440de526795408ef86 (patch)
treeb412e5187d839e2ff9ee2cc4e4c2d743bc5d9cd6 /src/construct/code_fenced.rs
parent4277dac07db06f24ba30a75b4c1dec542e32dae8 (diff)
downloadmarkdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.tar.gz
markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.tar.bz2
markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.zip
Add some improved docs
Diffstat (limited to 'src/construct/code_fenced.rs')
-rw-r--r--src/construct/code_fenced.rs11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/construct/code_fenced.rs b/src/construct/code_fenced.rs
index 2068a62..a440d40 100644
--- a/src/construct/code_fenced.rs
+++ b/src/construct/code_fenced.rs
@@ -1,4 +1,4 @@
-//! Code (fenced) is a construct that occurs in the flow content type.
+//! Code (fenced) is a construct that occurs in the [flow][] content type.
//!
//! It forms with the following BNF:
//!
@@ -63,10 +63,10 @@
//! </code></pre>
//! ```
//!
-//! The `info` and `meta` parts are interpreted as the string content type.
+//! The `info` and `meta` parts are interpreted as the [string][] content type.
//! That means that character escapes and character reference are allowed.
//!
-//! In markdown, it is also possible to use code (text) in the text content
+//! In markdown, it is also possible to use code (text) in the [text][] content
//! type.
//! It is also possible to create code with the
//! [code (indented)][code-indented] construct.
@@ -79,11 +79,14 @@
//! * [`code-fenced.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/code-fenced.js)
//! * [*ยง 4.5 Fenced code blocks* in `CommonMark`](https://spec.commonmark.org/0.30/#fenced-code-blocks)
//!
+//! [flow]: crate::content::flow
+//! [string]: crate::content::string
+//! [text]: crate::content::text
//! [code-indented]: crate::construct::code_indented
//! [html-pre]: https://html.spec.whatwg.org/multipage/grouping-content.html#the-pre-element
//! [html-code]: https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-code-element
//!
-//! <!-- To do: link `flow`, `text`, `code_text`, `string` -->
+//! <!-- To do: link `code_text` -->
use crate::constant::{CODE_FENCED_SEQUENCE_SIZE_MIN, TAB_SIZE};
use crate::construct::partial_whitespace::start as whitespace;