rust-random / book

The Rust Rand Book
Other
49 stars 19 forks source link

Broken links due to rand_distr split #46

Closed AVerm closed 2 years ago

AVerm commented 2 years ago

Overview

Severity: Low

I do not have the time and am not familiar with this codebase, but there are several broken links in the "guide-dist" page. This is due to the fact that the distributions were split out from this crate at some point in the past into the rand_dist crate.

Verification of Issue

Go to the documentation generated from this page and find this text:

The Normal distribution (also known as Gaussian) simulates sampling from the Normal distribution ("Bell curve") with the given mean and standard deviation.

The word "Normal" is pointing to the link

https://rust-random.github.com/rust-random/rand/rand/distributions/struct.Normal.html

but it should point to

https://rust-random.github.io/rand/rand_distr/struct.Normal.html

Explanation

This is because it is generated from the text

The [`Normal`] distribution (also known as Gaussian) simulates sampling from
the Normal distribution ("Bell curve") with the given mean and standard
deviation.

which uses a WIkilink style link.

Proposed Mitigation

This would need to be updated to use a full Markdown link (in the style (text)[URI]) to be fixed.

I have checked, and there are more instances of this on the page, probably many, so I don't want to try to fix only 1 or 2. If anyone more familiar with the project sees this, they might have a better idea which links need fixing.