diff options
author | Titus Wormer <tituswormer@gmail.com> | 2022-10-11 14:01:01 +0200 |
---|---|---|
committer | Titus Wormer <tituswormer@gmail.com> | 2022-10-11 14:01:01 +0200 |
commit | 43edc8fc9d204da962c92b9f9fef45ac8b6b03da (patch) | |
tree | 6731160f1f88b076cd9dd9acf72254c1f586b194 /src/construct | |
parent | 11c03fa7ea3b3442f553d98f9be77271c70a29da (diff) | |
download | markdown-rs-43edc8fc9d204da962c92b9f9fef45ac8b6b03da.tar.gz markdown-rs-43edc8fc9d204da962c92b9f9fef45ac8b6b03da.tar.bz2 markdown-rs-43edc8fc9d204da962c92b9f9fef45ac8b6b03da.zip |
Add some missing internal docs
Diffstat (limited to 'src/construct')
-rw-r--r-- | src/construct/attention.rs | 2 | ||||
-rw-r--r-- | src/construct/mod.rs | 10 |
2 files changed, 8 insertions, 4 deletions
diff --git a/src/construct/attention.rs b/src/construct/attention.rs index d99a52c..7ac41de 100644 --- a/src/construct/attention.rs +++ b/src/construct/attention.rs @@ -37,7 +37,7 @@ //! There are some small differences in whether sequences can open and/or close //! based on whether they are formed with asterisks or underscores. //! Because underscores also frequently occur in natural language inside words, -//! while asterisks typically never do, `CommonMark` prohobits underscore +//! while asterisks typically never do, `CommonMark` prohibits underscore //! sequences from opening or closing when *inside* a word. //! //! Because asterisks can be used to form the most markdown constructs, using diff --git a/src/construct/mod.rs b/src/construct/mod.rs index 88f3050..c78a002 100644 --- a/src/construct/mod.rs +++ b/src/construct/mod.rs @@ -1,7 +1,7 @@ //! Constructs found in markdown. //! //! Constructs are grouped by content type. -//! Which content type is allowed somewhere, defines which constructs are +//! Which content type is allowed somewhere, prescribes which constructs are //! allowed there. //! //! ## Content type @@ -24,11 +24,15 @@ //! There are several *things* found when parsing markdown, such as, say, a //! thematic break. //! These things are called constructs here. +//! //! Sometimes, there are several constructs that result in an equivalent thing. //! For example, [code (fenced)][raw_flow] and //! [code (indented)][code_indented] are considered different constructs. +//! Sometimes, constructs on their own don’t result in anything. +//! For example, a `*` is parsed as an attention sequence, but later when we +//! didn’t find another sequence, it’s turned back into plain data. //! -//! The following constructs are found in markdown (CommonMark): +//! The following constructs are found in markdown (`CommonMark`): //! //! * [attention][attention] (strong, emphasis, extension: GFM strikethrough) //! * [autolink][] @@ -64,9 +68,9 @@ //! * [gfm label start footnote][gfm_label_start_footnote] //! * [gfm table][gfm_table] //! * [gfm task list item check][gfm_task_list_item_check] +//! * [mdx esm][mdx_esm] //! * [mdx expression (flow)][mdx_expression_flow] //! * [mdx expression (text)][mdx_expression_text] -//! * [mdx esm][mdx_esm] //! * [mdx jsx (flow)][mdx_jsx_flow] //! * [mdx jsx (text)][mdx_jsx_text] //! |