Giters

ms705 / nom-sql

Rust SQL parser written using nom

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

fix unused doc comment warnings

efx opened this issue · comments

commented

When running the tests for the first time with cargo test I noticed multiple warnings about unused doc comments:

warning: unused doc comment
    --> src/common.rs:1021:1
     |
1021 |   /// Parse rule for a comment part.
     |   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1022 | / named!(pub parse_comment<CompleteByteSlice, String>,
1023 | |     do_parse!(
1024 | |         opt_multispace >>
1025 | |         tag_no_case!("comment") >>
...    |
1029 | |     )
1030 | | );
     | |__- rustdoc does not generate documentation for macro expansions
     |
     = help: to document an item produced by a macro, the macro must produce the documentation as part of its expansion

Should we follow the help suggestion and include the documentation line(s) in the macro or remove the documentation lines for now?

commented

Feel free to remove these lines! I thought I had already removed all of them, but clearly some remain.