Как вы обрабатываете предупреждение «не удалось разобрать блок кода как код Rust»? - PullRequest
0 голосов
/ 17 апреля 2019

Я пишу несколько примеров документов ржавчины (которые компилируются):

/// ```rust
/// # #[macro_use]
/// # extern crate ...
/// ...
/// ```

Но cargo doc выдает мне это [неправильное] предупреждение:

warning: could not parse code block as Rust code
   --> srml/support/src/dispatch.rs:105:5
    |
105 |   ///    ```rust
    |  ________^
106 | | /// # #[macro_use]
    | |_
    |
    = note: error from rustc: unknown start of token: `
help: mark blocks that do not contain Rust code as text
    |
105 | ///    ```textrust
    |        ^^^^^^^

Должен ли я простоподавить это предупреждение .. или здесь что-то не так?

1 Ответ

2 голосов
/ 17 апреля 2019

Вы исправляете ошибку, используя действительный код Rust внутри блока кода.


Это воспроизводит проблему:

///    ```rust
///
///    ```
pub fn foo() {}

Не добавляйте ложные пробелы перед вашими кодами. В Markdown четыре пробела считаются началом кода, поэтому вы фактически сделали эквивалент HTML:

<code>```rust  ```</code>

Как говорится, ``` не является допустимым кодом Rust.

...