nannou-org/nannou

Doc links broken

Open

#203 opened on Oct 28, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (4,662 stars) (254 forks)batch import
buggood first issue

Description

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.

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Rustdocumentation conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.