Skip to content

Commit 15e0ad5

Browse files
committed
docs: escape brackets in doc comments to fix rustdoc
1 parent bd9c357 commit 15e0ad5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/model/recipe_entry.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ use thiserror::Error;
1212
/// Represents the complete collection of step images for a recipe.
1313
///
1414
/// Images are discovered based on the Cooklang naming convention:
15-
/// - `RecipeName.N.ext`: Stored at [0][N-1] (section 0 = linear/no section)
16-
/// - `RecipeName.S.N.ext`: Stored at [S-1][N-1] (section S, step N)
15+
/// - `RecipeName.N.ext`: Stored at \[0\]\[N-1\] (section 0 = linear/no section)
16+
/// - `RecipeName.S.N.ext`: Stored at \[S-1\]\[N-1\] (section S, step N)
1717
///
1818
/// File numbering is one-indexed (Recipe.1.jpg = first step)
1919
/// Internal HashMap keys are zero-indexed
@@ -23,8 +23,8 @@ use thiserror::Error;
2323
#[derive(Debug, Clone, Serialize, Default)]
2424
pub struct StepImageCollection {
2525
/// Two-dimensional map: section_index -> step_index -> image_path
26-
/// - Section 0: steps for linear recipes (Recipe.N.ext stored at [0][N-1])
27-
/// - Section 1+: steps within sections (Recipe.S.N.ext stored at [S-1][N-1])
26+
/// - Section 0: steps for linear recipes (Recipe.N.ext stored at \[0\]\[N-1\])
27+
/// - Section 1+: steps within sections (Recipe.S.N.ext stored at \[S-1\]\[N-1\])
2828
///
2929
/// HashMap keys are zero-indexed
3030
pub images: HashMap<usize, HashMap<usize, String>>,

0 commit comments

Comments
 (0)