Как я могу добавить пример кода в документацию частного метода? - PullRequest
4 голосов
/ 01 июля 2019

При документировании внутренних функций модуля я хотел бы добавить в него пример кода:

// in private module foo

/// This functions does something etc.
/// Example:
/// ```
/// use mylib::foo::my_func;
/// assert_eq!(my_func(2), 3);
/// ```
fn my_func(x: i32) -> i32 {
    3
}

Запуск cargo test не работает, поскольку foo является частным (и должно быть), поэтому яполучить множество неудачных тестов.

Я читал о размещении тегов ignore во фрагменте кода, однако это не кажется хорошим решением, так как я бы предпочел проверить код.

Как правильно обращаться с такой ситуацией?

...