Broken link in unit test documentation

General Usage
1

I was reading the documentation on unit tests at

https://docs.julialang.org/en/v1/stdlib/Test/#~:text=adding%20tests%20to%20your%20Julia%20Package.. The highligted link which resolves to
https://pkgdocs.julialang.org/dev/creating-packages/#Adding-tests-to-the-package
appears to be broken.

2

Good catch! I think the correct link is https://pkgdocs.julialang.org/v1/creating-packages/#Adding-tests-to-the-package now

Do you want to try and fix the documentation yourself? All you have to do is click the “Edit on GitHub” button at the top right of the page, and then follow along :slight_smile: I can help if you’re stuck

3

Happy to give it a shot. The line that needs to be changed is at this link. But it appears to be using some kind of reference macro I am not familiar with → [adding tests to your Julia Package](@ref adding-tests-to-packages)

Any idea where this is defined or how to change it? I assume the original author does not want to hard code urls in the documentation.

4

This is from Documenter.jl:

https://documenter.juliadocs.org/stable/man/syntax/#@ref-link

Apparently it’s supposed to point to a subsection from a tutorial:

https://github.com/search?q=repo%3AJuliaLang%2Fjulia%20adding-tests-to-packages&type=code

No idea why that doesn’t work

1 Like