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

Remove spec links to source code #609

Open
Azquelt opened this issue May 3, 2024 · 1 comment
Open

Remove spec links to source code #609

Azquelt opened this issue May 3, 2024 · 1 comment
Labels

Comments

@Azquelt
Copy link
Member

Azquelt commented May 3, 2024

In many places, the spec links directly to java files or markdown files stored in github source control.

This is not good for several reasons:

  • Most of the links are to the main or master branch so the version of the linked document may no longer match the version of the spec.
  • Source code can be moved or refactored at any time, breaking the links.

There are several types of links in the spec and Javadoc:

@Azquelt
Copy link
Member Author

Azquelt commented May 13, 2024

Spotted a link to the rest client source: org.eclipse.microprofile.rest.client.inject.RegisterRestClient.

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

No branches or pull requests

1 participant