Skip to main content

collect_md_files

Function collect_md_files 

Source
pub fn collect_md_files(
    dir_path: &Path,
    base_prefix: &str,
    depth: usize,
    max_depth: usize,
    files: &mut Vec<(String, PathBuf)>,
) -> bool
Expand description

Collects md files.

§Parameters

§Returns

Returns true when the condition checked by crate::docs::collect_md_files holds and false otherwise.

§Performance

Performance is proportional to the size of the supplied inputs and any parsed or loaded data consumed by crate::docs::collect_md_files.

§Examples

ⓘ
let _result = pharos_runtime_docs::docs::collect_md_files(todo!(), todo!(), todo!(), todo!(), todo!());
  • crate::docs for adjacent helpers that share the same runtime surface.