From b0accb11f1aade55e9fc4dc0a1c1d1b8362ab5d9 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Wed, 22 Jun 2022 16:41:04 +0200 Subject: Add docs on encoding to definition, destination --- src/construct/definition.rs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'src/construct/definition.rs') diff --git a/src/construct/definition.rs b/src/construct/definition.rs index b545643..57c62a5 100644 --- a/src/construct/definition.rs +++ b/src/construct/definition.rs @@ -30,7 +30,7 @@ //! space_or_tab ::= ' ' | '\t' //! ``` //! -//! Definitions in markdown to not, on their own, relate to anything in HTML. +//! Definitions in markdown do not, on their own, relate to anything in HTML. //! When connected with a link (reference), they together relate to the `` //! element in HTML. //! The definition forms its `href`, and optionally `title`, attributes. @@ -41,6 +41,12 @@ //! That means that [character escapes][character_escape] and //! [character references][character_reference] are allowed. //! +//! For info on how to encode characters in URLs, see +//! [`partial_destination`][destination]. +//! For info on how to characters are encoded as `href` on `` or `src` on +//! `` when compiling, see +//! [`sanitize_uri`][sanitize_uri]. +//! //! ## Tokens //! //! * [`Definition`][TokenType::Definition] @@ -68,6 +74,8 @@ //! [string]: crate::content::string //! [character_escape]: crate::construct::character_escape //! [character_reference]: crate::construct::character_reference +//! [destination]: crate::construct::partial_destination +//! [sanitize_uri]: crate::util::sanitize_uri //! [html]: https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-a-element //! //! -- cgit