时间戳

首页 > 解决方案 > 是否可以在 docs.rs 上查看功能文档？

rust - 是否可以在 docs.rs 上查看功能文档？

问题描述

我正在docs.rs 上查看 gpio_cdev 的文档。

该板条箱的可选功能之一是async-tokio，它允许您编写异步代码来检查 GPIO 引脚。在gpio_cdev github 的首页上有一个使用AsyncLineEventHandle.

我看到的问题是 docs.rs 文档完全没有提到AsyncLineEventHandle，或者与 Async 有任何关系。

docs.rs 网站上是否有显示可选功能文档的按钮？可选功能是否从未在 docs.rs 上记录？还是由开发人员决定是否在 docs.rs 上包含可选功能的文档？我应该为此提交错误报告吗？

如果我使用本地生成它，我假设我能够看到文档cargo doc（尽管我没有尝试过）。这是唯一的选择吗？

编辑：确认只要我启用了该功能，本地生成的文档就会显示异步部分。

标签： rustrust-cargo

解决方案

docs.rs 中的文档是提前构建的。它不是即时生成的。因此，没有按钮。

在文档构建期间打开或关闭功能将取决于 crate 作者指定使用该功能以及在 docs.rs 中为文档编译打开该功能。看看关于/构建页面上的交叉编译部分，也许可以发送一个 PR 以gpio_cdev在 docs.rs 的文档构建期间打开所有功能？

推荐阅读