gossipsub: documented TODO

[drHuangMHT]

unused_doc_comments now generates warning.

rust-libp2p/protocols/gossipsub/src/types.rs

Line 333 in 38ea7ad

/// TODO, see https://github.com/libp2p/specs/pull/217

[thomaseizinger]

What kind of warning? Is it easy to fix?

It is a shame that denying warnings doesn't work for rustdoc: #3282

[drHuangMHT]

The warning is as follows:

warning: unused doc comment
   --> C:\Users\DrHuang\Documents\GithubProjects\rust-libp2p\protocols\gossipsub\src\types.rs:333:33
    |
333 | ...                   /// TODO, see https://github.com/libp2p/specs/pull/217
    |                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
334 | ...                   signed_peer_record: None,
    |                       ------------------------ rustdoc does not generate documentation for expression fields
    |
    = help: use `//` for a plain comment
    = note: `#[warn(unused_doc_comments)]` on by default

The easiest fix will be changing triple slashes to double slashes, but #217 has been resolved.

[thomaseizinger]

The relevant feature here is called "peer exchange" and is tracked here: #2398

Could you send a PR though to fix the warning by not using a triple-slash?

[drHuangMHT]

Fixed in #4811.