#documentation #spelling #lint #plugin

nightly ronat

Rust 文档检查器

1 个不稳定版本

使用旧的 Rust 2015

0.1.0 2017年1月15日

#28 in #spelling

MIT/Apache

11KB
190 代码行数(不含注释)

Ronat

检查您的注释中的拼写错误!

该项目处于非常早期阶段,任何反馈都将受到欢迎!

用法

一般来说,ronat 将尝试与最新稳定版本的第一个夜间版本一起工作。

当前测试的版本是: nightly-2016-12-19

可选依赖

如果您想将 ronat 设置为可选依赖项,您可以这样做

在您的 Cargo.toml

[dependencies]
ronat = {version = "*", optional = true}

[features]
default = []

并在您的 main.rslib.rs

#![cfg_attr(feature="ronat", feature(plugin))]
#![cfg_attr(feature="ronat", plugin(ronat))]

然后通过启用功能来构建: cargo build --features "ronat"

配置

使用默认的 en 字典,它不识别许多常见的 Rust 和编程术语,您将获得很多误报。为了防止这种情况,您可以在您的 HOME 目录中设置一个 .aspell.en.pws 文件。

您可以在 example/.aspell.en.pws 下找到用于此的示例文件。

致谢

感谢以下人员

该项目以语言学家 Mitsou Ronat 命名。

许可协议

许可协议为以下之一

任选其一。

依赖项

~4.5MB
~95K SLoC