Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix link to SnoopCompile docs #2156

Merged
merged 1 commit into from
Oct 5, 2024
Merged

Conversation

alecloudenback
Copy link
Contributor

prior link 404s

@@ -330,7 +330,7 @@ It's worth noting that the task of improving code is never finished, and this is
## Tools for analyzing and fixing invalidations

Recently, the [SnoopCompile] package gained the ability to analyze invalidations and help developers fix them.
Because these tools will likely change over time, this blog post will only scratch the surface; people who want to help fix invalidations are encouraged to read [SnoopCompile's documentation](https://timholy.github.io/SnoopCompile.jl/stable/snoopr/) for further detail.
Because these tools will likely change over time, this blog post will only scratch the surface; people who want to help fix invalidations are encouraged to read [SnoopCompile's documentation](https://timholy.github.io/SnoopCompile.jl/dev/) for further detail.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like it would be better to link to the stable docs instead of the dev docs, right?

The following URL seems to work:

Suggested change
Because these tools will likely change over time, this blog post will only scratch the surface; people who want to help fix invalidations are encouraged to read [SnoopCompile's documentation](https://timholy.github.io/SnoopCompile.jl/dev/) for further detail.
Because these tools will likely change over time, this blog post will only scratch the surface; people who want to help fix invalidations are encouraged to read [SnoopCompile's documentation](https://timholy.github.io/SnoopCompile.jl/stable/) for further detail.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the main page doesn't link to stable docs, which made me think Tim wants people to go to dev docs: https://github.com/timholy/SnoopCompile.jl

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, interesting.

@timholy Which one (stable or dev) should we link to on the Julia website?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll merge this to fix the 404. Necessary changes can follow.

@IanButterworth IanButterworth merged commit 7ab7497 into JuliaLang:main Oct 5, 2024
3 checks passed
@alecloudenback alecloudenback deleted the patch-1 branch October 5, 2024 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants