#extension #doctest #codegen #struct #disable #autogenerated #tonic-build

tonic-disable-doctest

禁用自动生成代码中的 doctest 保留文档字符串

1 个不稳定版本

0.1.0 2023年5月25日

#7 in #doctest

Download history 95/week @ 2024-03-13 12/week @ 2024-03-20 30/week @ 2024-03-27 83/week @ 2024-04-03 54/week @ 2024-04-10 5/week @ 2024-04-24 9/week @ 2024-05-01 8/week @ 2024-05-08 20/week @ 2024-05-15 1/week @ 2024-05-22 6/week @ 2024-05-29 24/week @ 2024-06-05 16/week @ 2024-06-12 130/week @ 2024-06-19 31/week @ 2024-06-26

每月203 次下载

MIT 许可证

7KB
74

tonic-disable-doctest

为由 tonic_build 自动生成的特定结构体分离文档字符串。在自动生成输入的注释包含将被错误地处理为 rust 代码的代码的情况下,这可能很有用,且您无法控制输入。这将禁用这些文档的 doctest,同时在单独的结构体中保留文档字符串。


lib.rs:

tonic_build 扩展,允许禁用特定结构体的 doctest

允许将 tonic_build 自动生成的特定结构体的文档字符串分开。在自动生成输入的注释包含将被错误地处理为 rust 代码的代码的情况下,这可能很有用。此扩展允许在保留与原始结构体中文档字符串链接的单独结构体中的文档字符串的同时禁用这些文档的 doctest。

在使用此技巧后,即使自动生成的代码通常包含导致它失败的违规部分,完整的 doctest 运行也应通过。例如,在 SO 问题

依赖关系

~3MB
~59K SLoC