nannou-org/nannou

Doc links broken

Open

#203 创建于 2018年10月28日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Rust (4,662 star) (254 fork)batch import
buggood first issue

描述

The doc link for 'Draw type' in src/draw/mod.rs points to ./struct.Draw.html which works fine if read from the draw module. In the top-level crate documentation this comment appears too, in which case the link is broken. The same goes for multiple other links. Not sure if absolute links are better, as locally generated and read docs would then point to the external docs.

贡献者指南

技术栈
rust
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic Rustdocumentation conventions
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
The issue is in the nannou repository. The problem is relative doc links in `src/draw/mod.rs` that work in the draw module but break in top level crate docs. Check the file for all occurrences of relative links like `./struct.Draw.html` and replace them with absolute links (e.g., `https://docs.rs/nannou/...`) or use Rust's doc link syntax to ensure they work from any context. Also verify that no other modules have similar issues by searching for `./` in doc comments.