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

Violation messages and Example of Usage links do not work. #12905

Closed
Vyom-Yadav opened this issue Mar 25, 2023 · 8 comments
Closed

Violation messages and Example of Usage links do not work. #12905

Vyom-Yadav opened this issue Mar 25, 2023 · 8 comments

Comments

@Vyom-Yadav
Copy link
Member

Vyom-Yadav commented Mar 25, 2023

The hyperlink for violation messages does not work anymore.
Screenshot from 2023-03-25 08-49-53

This link directs to:
Screenshot from 2023-03-25 08-53-10

GitHub suggests the correct path i.e. https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fcoding+path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22array.trailing.comma%22&type=code

The same is true for Example_of_Usage section.

Update the hyperlinks of all the checks and make sure they're correct. This can be done for all checks using awk, etc., or in IDE features like find and replace.

The GitHub docs still show it as working but it is not actually working, opened github/docs#24666 for the same.

@Vyom-Yadav Vyom-Yadav changed the title Violation messages link does not work. Violation messages and Example of Usage links do not work. Mar 25, 2023
@romani
Copy link
Member

romani commented Mar 25, 2023

this works: path:src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding filename:messages*.properties repo:checkstyle/checkstyle 'variable.declaration.usage.distance'

I used single quotes ' instead ".

this link works: https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fcoding+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%27variable.declaration.usage.distance%27

we need to update whole xdoc codebase to use single quotes.

@romani
Copy link
Member

romani commented Mar 25, 2023

<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fcoding+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22unused.local.var%22">

+%22 should be changed to +%27
%22"> should be changed to %27">

@Vyom-Yadav
Copy link
Member Author

I used single quotes ' instead ".

Single quotes don't work for me, double quotes do, how is it the reverse?

@romani
Copy link
Member

romani commented Mar 25, 2023

try to open it few times, it looks like not stable, but it works periodically.

@Vyom-Yadav
Copy link
Member Author

The only thing working for me consistently is:
path:src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding path:**/messages*.properties repo:checkstyle/checkstyle "variable.declaration.usage.distance"

@romani
Copy link
Member

romani commented Mar 25, 2023

I remember such problems even before, it was unstable , but nothing we can do, it is GitHub, you can open issue on them instead.

@romani
Copy link
Member

romani commented May 24, 2023

Fixed by #13059 (comment)

@romani romani closed this as completed May 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants