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.

Sign up for GitHub

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

Jump to bottom

Existing links to the current version's ScalaDoc are broken in 2.12.0 #10029

Open
scabug opened this issue Nov 4, 2016 · 5 comments
Open

Existing links to the current version's ScalaDoc are broken in 2.12.0 #10029

scabug opened this issue Nov 4, 2016 · 5 comments
Labels
good first issue scaladoc tool
Milestone
Backlog

Comments

@scabug
Copy link

scabug commented Nov 4, 2016

Existing links to ScalaDoc that target the current version of Scala (i.e. links such as http://www.scala-lang.org/api/current/index.html#scala.Int) now ends up at the ScalaDoc start page instead of the intended sub page (the sample link must instead now be written as http://www.scala-lang.org/api/current/scala/Int.html). This affects many existing links on StackOverflow.com and other sites with Scala-related information. Perhaps a response with a permanent redirect can be returned for any links using the old format so that the user ends up at the correct page.
@scabug
Copy link
Author

scabug commented Nov 4, 2016

Imported From: https://issues.scala-lang.org/browse/SI-10029?orig=1
Reporter: Odd Möller (odd)
Affected Versions: 2.12.0

@scabug scabug closed this as completed Nov 7, 2016
@scabug
Copy link
Author

scabug commented Nov 7, 2016

@SethTisue said:
could you report this at https://github.com/scala/scala-lang/issues please?

@sjrd
Copy link
Member

sjrd commented Jun 30, 2017

This needs to be fixed in the Scaladoc generation of 2.12. It needs to interpret #-based links and redirect them to the new style. It affects the Scaladocs of all libraries that previously published them from 2.11 and now from 2.12.

For example, the following link:
https://www.scala-js.org/api/scalajs-library/1.0.0-M1/#scala.scalajs.js.package
should redirect to
https://www.scala-js.org/api/scalajs-library/1.0.0-M1/scala/scalajs/js/index.html

https://github.com/scala/scala-lang/issues is not the right place to report this problem. The present issue tracker is.

IMO this issue should be reopened.

@lrytz lrytz reopened this Jul 3, 2017
@szeiger
Copy link
Member

szeiger commented Jun 25, 2019

FYI: https://github.com/sbt/sbt-sdlc can now check scaladoc 2.12 links so you can at least identify them for a (manual) rewrite.

@sjrd sjrd mentioned this issue Nov 29, 2019
Closed
@SethTisue SethTisue added this to the Backlog milestone Jan 30, 2021
@SethTisue
Copy link
Member

Is this still an issue in 2.13, or was it truly a 2.12-only situation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue scaladoc tool
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
5 participants
@szeiger @lrytz @SethTisue @sjrd @scabug