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.