From 769e7011d37a2ad54630aeebdb0b0163a0825f75 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Tue, 28 Jun 2022 14:42:42 +0200 Subject: Add docs for `RESOURCE_DESTINATION_BALANCE_MAX` --- readme.md | 2 +- src/constant.rs | 11 ++++++++--- src/construct/label_end.rs | 4 ++-- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 5509d8c..9dd546f 100644 --- a/readme.md +++ b/readme.md @@ -124,7 +124,6 @@ cargo doc --document-private-items #### Docs -- [ ] (1) `LINK_RESOURCE_DESTINATION_BALANCE_MAX` in constants - [ ] (1) `label_start_image`, `label_start_link` - [ ] (1) `label_end` - [ ] (1) `space_or_tab_one_line_ending` @@ -284,3 +283,4 @@ important. - [x] (1) Add docs for how references and definitions match - [x] (1) Add module docs to parser - [x] (1) Add improved docs in compiler +- [x] (1) Add docs for `RESOURCE_DESTINATION_BALANCE_MAX` diff --git a/src/constant.rs b/src/constant.rs index 5cb7826..fc74316 100644 --- a/src/constant.rs +++ b/src/constant.rs @@ -193,10 +193,15 @@ pub const HTML_RAW_SIZE_MAX: usize = 8; /// To safeguard performance, labels are capped at a large number: `999`. pub const LINK_REFERENCE_SIZE_MAX: usize = 999; -/// To do. +/// Maximum allowed unbalanced parens in destination. +/// +/// There can be many balanced parens, but if there are 33 opens that were not +/// yet closed, the destination does not parse. +/// `CommonMark` requires that at least 3 opening parens are allowed. /// See: , -/// . -pub const LINK_RESOURCE_DESTINATION_BALANCE_MAX: usize = 32; +/// In practice, this is quite low, and several places instead cap it at 32. +/// See: . +pub const RESOURCE_DESTINATION_BALANCE_MAX: usize = 32; /// List of protocols allowed, when operating safely, as `href` on `a`. /// diff --git a/src/construct/label_end.rs b/src/construct/label_end.rs index 6e8e476..a814302 100644 --- a/src/construct/label_end.rs +++ b/src/construct/label_end.rs @@ -1,6 +1,6 @@ //! To do -use crate::constant::LINK_RESOURCE_DESTINATION_BALANCE_MAX; +use crate::constant::RESOURCE_DESTINATION_BALANCE_MAX; use crate::construct::{ partial_destination::{start as destination, Options as DestinationOptions}, partial_label::{start as label, Options as LabelOptions}, @@ -436,7 +436,7 @@ fn resource_open(tokenizer: &mut Tokenizer, code: Code) -> StateFnResult { t, c, DestinationOptions { - limit: LINK_RESOURCE_DESTINATION_BALANCE_MAX, + limit: RESOURCE_DESTINATION_BALANCE_MAX, destination: TokenType::ResourceDestination, literal: TokenType::ResourceDestinationLiteral, marker: TokenType::ResourceDestinationLiteralMarker, -- cgit