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 a broken link in docs #560

Closed
wants to merge 1 commit into from
Closed

fix a broken link in docs #560

wants to merge 1 commit into from

Conversation

ctarn
Copy link

@ctarn ctarn commented Sep 19, 2024

No description provided.

Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.09%. Comparing base (313a04f) to head (d6dad30).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #560   +/-   ##
=======================================
  Coverage   84.09%   84.09%           
=======================================
  Files          12       12           
  Lines        9102     9102           
=======================================
  Hits         7654     7654           
  Misses       1448     1448           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fredrikekre
Copy link
Member

Where do you see a broken link?

@ctarn
Copy link
Author

ctarn commented Sep 19, 2024

Where do you see a broken link?

in the doc of stdlib of julia (https://docs.julialang.org/en/v1/stdlib/SparseArrays/). click Noteworthy external packages and it will jump to https://docs.julialang.org/en/v1/stdlib/SparseArrays/#man-csc by mistake

it should be caused by the undefined ref, and redirecting to #man-csc may be a bug (or feature) of Documentor.jl. for now we can simply add an id to the section.

@ctarn
Copy link
Author

ctarn commented Sep 19, 2024

should we use a more specific id instead? I am not so familiar with Documentor.jl and am worried that the docs of julia may have used the id, and may raise a conflict.

@fredrikekre
Copy link
Member

Okay, looks like it has already been fixed in #430 so I think that PR should just be backported to 1.10

@ctarn
Copy link
Author

ctarn commented Sep 19, 2024

Yes! It has been fixed in the docs of 1.12-dev. I am going to close the PR.
BTW, jump to [#man-csc](https://docs.julialang.org/en/v1/stdlib/SparseArrays/#man-csc) may be a bug of Documentor.jl. I noticed that you are a member of JuliaDocs, and maybe I don't have to create another issue in JuliaDocs :).
Thanks!

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.

4 participants