charlesvdv / nom-bibtex

A feature complete bibtex parser using nom
https://docs.rs/nom-bibtex
MIT License
24 stars 15 forks source link

Fix doc comment warnings #5

Closed TheZoq2 closed 4 years ago

TheZoq2 commented 4 years ago

When building the crate, it produces lots of warnings along the lines of

warning: unused doc comment
   --> src/parser.rs:110:1
    |
110 |   /// String variable can be delimited by brackets or parenthesis.
    |   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
111 | / named!(handle_variable<CompleteByteSlice, KeyValue>,
112 | |     ws!(
113 | |         alt!(
114 | |            delimited!(
...   |
124 | |     )
125 | | );
    | |__- 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

As this doesn't seem like public API, I simply made those doc comments normal comments to silence the warnings

charlesvdv commented 4 years ago

Looks good to me! :+1: