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
In the Linux kernel we had some documentation added with /// instead of //!, which meant the docs applied to a use line and thus silently discarded.
Advantage
Documentation is not discarded silently.
Drawbacks
False positives when someone does want to document an item that follows. However, if it is something like a private use, it is likely it was a mistake. Thus the lint should limit itself to such cases.
What it does
In the Linux kernel we had some documentation added with
///
instead of//!
, which meant the docs applied to ause
line and thus silently discarded.Advantage
Documentation is not discarded silently.
Drawbacks
False positives when someone does want to document an item that follows. However, if it is something like a private
use
, it is likely it was a mistake. Thus the lint should limit itself to such cases.Example
Both
and
should probably have been written as
The text was updated successfully, but these errors were encountered: