Skip to content

Scaladoc: possibility to verify links in docs #16229

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

Open
KacperFKorban opened this issue Oct 21, 2022 · 2 comments · May be fixed by #17163
Open

Scaladoc: possibility to verify links in docs #16229

KacperFKorban opened this issue Oct 21, 2022 · 2 comments · May be fixed by #17163

Comments

@KacperFKorban
Copy link
Member

Scaladoc should be able to verify the correctness of links in docstrings and static sites.

Motivation: It's hard to check the correctness of links manually when changing the documentation.
e.g.

https://dotty.epfl.ch/api/scala/runtime/stdLibPatches/language$$unsafeNulls$.html# points to http://dotty.epfl.ch/docs/reference/other-new-features/explicit-nulls.html which has been moved to https://dotty.epfl.ch/docs/reference/experimental/explicit-nulls.html

We should be able to detect incorrect links (usually pointing to 404) when generating scaladoc.

Some thoughts:

  • This should be under a flag possibly, since making HTTP calls should definitely not be a default behavior for a doctool
  • We should detect changes in the static site inside of the same repo
@Dedelweiss
Copy link
Contributor

Hello @szymon-rd, I saw that you are currently assigned to this issue. I have started working on this problem and I just wanted to know if you had started anything?

@szymon-rd
Copy link
Contributor

Hi, no, I did not start working on it.

@Dedelweiss Dedelweiss linked a pull request Mar 28, 2023 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants