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

Manual: Incorrect Hyperlink for Package Extensions in Performance Tips #58073

Open
leespen1 opened this issue Apr 10, 2025 · 2 comments
Open
Labels
docs This change adds or pertains to documentation docsystem The documentation building system

Comments

@leespen1
Copy link

In the Performance Tips section, Reducing Package Loading Time subsection (https://docs.julialang.org/en/v1/manual/performance-tips/#Reducing-package-loading-time), in the first numbered item in the list:

"Reduce your dependencies to those you really need. Consider using package extensions to support interoperability with other packages without bloating your essential dependencies."

The hyperlink for "package extensions" is https://docs.julialang.org/en/v1/base/math/#Base.:--Tuple{Any,%20Any}, which links to the method documentation for Base.:-.

I believe the correct hyperlink should be https://docs.julialang.org/en/v1/manual/code-loading/#man-extensions.

@nsajko nsajko added docs This change adds or pertains to documentation docsystem The documentation building system labels Apr 10, 2025
@nsajko
Copy link
Contributor

nsajko commented Apr 10, 2025

Relevant line of Markdown:

1. Reduce your dependencies to those you really need. Consider using [package extensions](@ref) to support interoperability with other packages without bloating your essential dependencies.

How does the doc system choose the doc string for -, specifically?

@barucden
Copy link
Contributor

How does the doc system choose the doc string for -, specifically?

A bug in Documenter.jl in my opinion. I created an issue JuliaDocs/Documenter.jl#2677

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation docsystem The documentation building system
Projects
None yet
Development

No branches or pull requests

3 participants