diff options
| author | mo8it <mo8it@proton.me> | 2024-05-13 21:40:40 +0200 |
|---|---|---|
| committer | mo8it <mo8it@proton.me> | 2024-05-13 21:40:40 +0200 |
| commit | d48e86b1540dcf649412c088cc50161f3e356e26 (patch) | |
| tree | 4c2e4c833ccb8797795e7a9e2858f6b2d8f140f9 /src/embedded.rs | |
| parent | 39a19f945008ef59af107fe54d9dc62943469c8b (diff) | |
Use public comments for public items
Diffstat (limited to 'src/embedded.rs')
| -rw-r--r-- | src/embedded.rs | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/embedded.rs b/src/embedded.rs index bc1a5cc..6f87068 100644 --- a/src/embedded.rs +++ b/src/embedded.rs @@ -6,7 +6,7 @@ use std::{ use crate::info_file::ExerciseInfo; -// Contains all embedded files. +/// Contains all embedded files. pub static EMBEDDED_FILES: EmbeddedFiles = rustlings_macros::include_files!(); #[derive(Clone, Copy)] @@ -73,16 +73,16 @@ impl ExerciseDir { } } -// All embedded files. +/// All embedded files. pub struct EmbeddedFiles { - // `info.toml` + /// The content of the `info.toml` file. pub info_file: &'static str, exercise_files: &'static [ExerciseFiles], exercise_dirs: &'static [ExerciseDir], } impl EmbeddedFiles { - // Dump all the embedded files of the `exercises/` direcotry. + /// Dump all the embedded files of the `exercises/` direcotry. pub fn init_exercises_dir(&self, exercise_infos: &[ExerciseInfo]) -> Result<()> { create_dir("exercises").context("Failed to create the directory `exercises`")?; @@ -110,7 +110,7 @@ impl EmbeddedFiles { WriteStrategy::Overwrite.write(path, exercise_files.exercise) } - // Write the solution file to disk and return its path. + /// Write the solution file to disk and return its path. pub fn write_solution_to_disk( &self, exercise_ind: usize, |
