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

Docs function anchors not working on the first use #28858

Open
mathjeff opened this issue Apr 17, 2024 · 2 comments
Open

Docs function anchors not working on the first use #28858

mathjeff opened this issue Apr 17, 2024 · 2 comments

Comments

@mathjeff
Copy link
Contributor

mathjeff commented Apr 17, 2024

Current Behavior

I'm noticing on docs.gradle.org that the first time I click on a function name, it doesn't take me to the detailed documentation for the function.

Expected Behavior

It would be nice if clicking on a function name in the docs navigated to the detailed documentation on the first try

Context (optional)

No response

Steps to Reproduce

  1. Open https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html in a browser
  2. Reload the page without the cache, by pushing ctrl-shift-r
  3. Search for the "findProperty" method by pushing shift-f and typing findproperty
  4. Notice that the screen says java.lang.Object [findProperty](https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html#findProperty-java.lang.String-)​(java.lang.String propertyName) Returns the value of the given property or null if not found.
  5. Click the "findProperty" hyperlink
  6. Notice that the browser url changes to https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html#findProperty-java.lang.String- but the content onscreen doesn't scroll to the detailed documentation of "findProperty"
  7. Click "findProperty" again
  8. Notice that the screen scrolls to the detailed documentation of "findProperty"

Gradle version

The version of the docs that I'm looking at is 8.7

Build scan URL (optional)

No response

Your Environment (optional)

I'm using Google Chrome version 123.0.6312.105 (Official Build) (64-bit)

Thanks!

@mathjeff mathjeff changed the title Docs anchors not working on the first use Docs function anchors not working on the first use Apr 17, 2024
@ov7a
Copy link
Member

ov7a commented Apr 18, 2024

I can confirm. However, it only happens in Chrome, I see no issue in Firefox or Safari.

@mathjeff can you confirm that?

It might be an issue with JavaDoc. I wonder if it happens for other JavaDocs.

@mathjeff
Copy link
Contributor Author

Neat - yeah, when I test this with Firefox I find that it works correctly for me

@ov7a ov7a removed the to-triage label Apr 19, 2024
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