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

Scaladoc companion and package links hard for newcomers to find #9006

Closed
scabug opened this issue Nov 26, 2014 · 2 comments
Closed

Scaladoc companion and package links hard for newcomers to find #9006

scabug opened this issue Nov 26, 2014 · 2 comments

Comments

@scabug
Copy link

scabug commented Nov 26, 2014

While companion and package links are easy to navigate to when you know where to find them in scaladoc, many newcomers are unaware that the links exist, fail to notice the peel-over on the class icon or that the package breadcrumbs are navigable, and are constantly surprised to find the often essential documentation hidden behind these links. A simple explanation on the right hand side of the title bar in scaladoc would surely help this:

For classes/traits without companions:

Go to package docs

for classes/traits with companions:

Go to companion or package docs

@scabug
Copy link
Author

scabug commented Nov 26, 2014

Imported From: https://issues.scala-lang.org/browse/SI-9006?orig=1
Reporter: @dickwall
Affected Versions: 2.11.4

@scabug
Copy link
Author

scabug commented Dec 5, 2014

@adriaanm said:
scala/scala#4165

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants