search

rust-lang / cfg-if

A if/elif-like macro for Rust #[cfg] statements
Apache License 2.0
557 stars 40 forks source link

Fix doc warnings #14

Closed kpp closed 6 years ago

kpp commented 6 years ago 
 Documenting cfg-if v0.1.3 (file:///home/humbug/cfg-if)
warning: `[cfg]` cannot be resolved, ignoring it...
 --> src/lib.rs:1:28
  |
1 | //! A macro for defining #[cfg] if-else statements.
  |                            ^^^ cannot be resolved, ignoring
  |
  = note: #[warn(intra_doc_link_resolution_failure)] on by default
  = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[cfg]` cannot be resolved, ignoring it...
 --> src/lib.rs:7:59
  |
7 | //! This allows you to conveniently provide a long list #[cfg]'d blocks of code
  |                                                           ^^^ cannot be resolved, ignoring
  |
  = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

    Finished dev [unoptimized + debuginfo] target(s) in 0.22s

$ rustc --version rustc 1.28.0-nightly (01cc982e9 2018-06-24)

kpp commented 6 years ago

Ah. Duplicate to https://github.com/alexcrichton/cfg-if/pull/11

kpp commented 6 years ago

Note:

error: `[cfg]` cannot be resolved, ignoring it...
 --> /home/humbug/.cargo/registry/src/github.com-1ecc6299db9ec823/cfg-if-0.1.3/src/lib.rs:1:28
  |
1 | //! A macro for defining #[cfg] if-else statements.
  |                            ^^^ cannot be resolved, ignoring
  |
note: lint level defined here
 --> /home/humbug/.cargo/registry/src/github.com-1ecc6299db9ec823/net2-0.2.32/src/lib.rs:42:23
  |
42| #![deny(missing_docs, warnings)]
  |                       ^^^^^^^^
  = note: #[deny(intra_doc_link_resolution_failure)] implied by #[deny(warnings)]
  = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

error: `[cfg]` cannot be resolved, ignoring it...
 --> /home/humbug/.cargo/registry/src/github.com-1ecc6299db9ec823/cfg-if-0.1.3/src/lib.rs:7:59
  |
7 | //! This allows you to conveniently provide a long list #[cfg]'d blocks of code
  |                                                           ^^^ cannot be resolved, ignoring
  |
  = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

error: Could not document `net2`.
gnzlbg commented 6 years ago

@kpp thanks for the PR, alex will be back at the end of the month, could you close this in the mean time, a couple of other PRs already address this issue.