Address clippy fixes in the generated documentation #107
Open
Description
-
The document generated should have backticks
For example:
Current behavior: /// RuleGroup is a list of sequentially evaluated
Expected behavior: ///RuleGroup
is a list of sequentially evaluated -
Bare URLs should be between
<
/>
or should be made a proper Markdown links
Current behavior: More info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response
Expected behavior More info
or /https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response/
For more info:
https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown