You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
In Rust, you can put code in method-documentation such that this code is checked.
Because this code in markdown format
/// Blabla////// # Examples////// ```/// # let my_var = 1; // you can hide code lines from doc, there are still checked/// assert_eq!(my_var, 1);/// ```pubfnmy_func(){}
ltex will check the code part in the documentation as natural-language, and thus produces false positives.
Describe the solution you'd like
The code under markdown code part in Rust documentation should not be checked
The comments in codes that are under markdown code part in Rust documentation should be checked
Describe alternatives you've considered
Just ignore markdown code part in Rust documentation, but we will face a false negative issue.
First, thank you for your amazing work!
Is your feature request related to a problem? Please describe.
In Rust, you can put code in method-documentation such that this code is checked.
Because this code in markdown format
ltex
will check the code part in the documentation as natural-language, and thus produces false positives.Describe the solution you'd like
Describe alternatives you've considered
Just ignore markdown code part in Rust documentation, but we will face a false negative issue.
Additional context
//
,///
,///
,//!
(https://doc.rust-lang.org/reference/comments.html)#
sign just hide code line from the doc, but it is still checked code (https://doc.rust-lang.org/rustdoc/write-documentation/what-to-include.html#examples)The text was updated successfully, but these errors were encountered: