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

Javadoc contains dead links to readme #675

Closed
5 tasks done
Farbfetzen opened this issue Oct 23, 2023 · 1 comment · Fixed by #676
Closed
5 tasks done

Javadoc contains dead links to readme #675

Farbfetzen opened this issue Oct 23, 2023 · 1 comment · Fixed by #676
Labels
bug This points to a verified bug in the code

Comments

@Farbfetzen
Copy link

Farbfetzen commented Oct 23, 2023

Checklist

  • I have looked into the Readme and Examples, and have not found a suitable solution or answer.
  • I have looked into the API documentation and have not found a suitable solution or answer.
  • I have searched the issues and have not found a suitable solution or answer.
  • I have searched the Auth0 Community forums and have not found a suitable solution or answer.
  • I agree to the terms within the Auth0 Code of Conduct.

Description

The documentation in the code contains some dead links to the readme. For example see https://github.com/auth0/java-jwt/blob/master/lib/src/main/java/com/auth0/jwt/algorithms/Algorithm.java#L187. There is no section "hmac-key-length-and-security" in the current readme.

Reproduction

Click on the link in the javadoc of com.auth0.jwt.algorithms.Algorithm#HMAC512(java.lang.String).

Additional context

No response

java-jwt version

4.4.0

Java version

any

@Farbfetzen Farbfetzen added the bug This points to a verified bug in the code label Oct 23, 2023
@jimmyjames
Copy link
Contributor

Thanks @Farbfetzen for raising! We'll get this fixed up this week. If you'd like to open a PR to fix broken links you see, feel free and we can review, otherwise we'll get something out this week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This points to a verified bug in the code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants