Skip to content

Commit 16bbdeb

Browse files
author
Lukasz Anforowicz
committed
Small, comment-only (and whitespace-only) tweaks after a self-review.
1 parent 01fc603 commit 16bbdeb

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/comment.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ impl CodeBlockAttribute {
436436
/// `12.` or `34)` (with at most 2 digits). An item represents CommonMark's ["list
437437
/// items"](https://spec.commonmark.org/0.30/#list-items) and/or ["block
438438
/// quotes"](https://spec.commonmark.org/0.30/#block-quotes), but note that only a subset of
439-
/// CommonMark is recognized - see the doc comment of `ItemizedBlock::get_marker_length` for more
439+
/// CommonMark is recognized - see the doc comment of [`ItemizedBlock::get_marker_length`] for more
440440
/// details.
441441
///
442442
/// Different level of indentation are handled by shrinking the shape accordingly.
@@ -453,9 +453,9 @@ struct ItemizedBlock {
453453

454454
impl ItemizedBlock {
455455
/// Checks whether the `trimmed` line includes an item marker. Returns `None` if there is no
456-
/// marker. Returns the length of the marker if one is present. Note that the length includes
457-
/// the whitespace that follows the marker, for example the marker in `"* list item"` has the
458-
/// length of 2.
456+
/// marker. Returns the length of the marker (in bytes) if one is present. Note that the length
457+
/// includes the whitespace that follows the marker, for example the marker in `"* list item"`
458+
/// has the length of 2.
459459
///
460460
/// This function recognizes item markers that correspond to CommonMark's
461461
/// ["bullet list marker"](https://spec.commonmark.org/0.30/#bullet-list-marker),
@@ -477,7 +477,7 @@ impl ItemizedBlock {
477477
// https://spec.commonmark.org/0.30/#block-quote-marker
478478
let itemized_start = ["* ", "- ", "> ", "+ "];
479479
if itemized_start.iter().any(|s| trimmed.starts_with(s)) {
480-
return Some(2); // All items in `itemized_start` have length 2.
480+
return Some(2); // All items in `itemized_start` have length 2.
481481
}
482482

483483
// https://spec.commonmark.org/0.30/#ordered-list-marker, where at most 2 digits are

0 commit comments

Comments
 (0)