nannou-org/nannou

Doc links broken

Open

#203 opened on 2018年10月28日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Rust (4,662 stars) (254 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.