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

Clicking Scaladoc navigational links should not expand unrelated documentation #9758

Open
scabug opened this issue Apr 16, 2016 · 2 comments

Comments

@scabug
Copy link

scabug commented Apr 16, 2016

When clicking on shouldRethrow in the constructor param list for Catch the constructor parameter documentation is momentarily revealed but then as expected the page is navigated away. The parameter documentation should only expand when the click leaves the user on the page. Expanding the documentation and then leaving the page appeared to me initially as a functional defect rather than the cosmetic one it is. The UI would be better off without this confusing visual cueing.

http://www.scala-lang.org/files/archive/nightly/2.12.x/api/2.12.x/scala/util/control/Exception$$Catch.html
!scaladoc-Catch-shouldRethrow-param-doc-link.png!

This fuzzy video takes the viewer through the shocking events leading up to the tragic outcome that no one present that April evening would ever forget: https://youtu.be/1l9kPlwmv14

@scabug
Copy link
Author

scabug commented Apr 16, 2016

Imported From: https://issues.scala-lang.org/browse/SI-9758?orig=1
Reporter: @janekdb
Affected Versions: 2.12.0-M5
Attachments:

@scabug
Copy link
Author

scabug commented Apr 17, 2016

@janekdb said:
On closer inspection this is a known issue where the target member of the link is not highlighted on arrival at the page. shouldRethrow is present further down the page but this is not clear without the visual cue.

The momentary disclosure of documentation on the page with the link when the link is clicked is a separate issue. Having said that the initial report in Jira is a fair account of what an occasional viewer could think happened. Because of this I have edited this issue to detail the lesser issue of page navigation actions also initiating documentation expansions.

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