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

create xdoc documetation page to explain details of Xpath support #9074

Open
romani opened this issue Dec 2, 2020 · 2 comments
Open

create xdoc documetation page to explain details of Xpath support #9074

romani opened this issue Dec 2, 2020 · 2 comments
Labels

Comments

@romani
Copy link
Member

romani commented Dec 2, 2020

We have a lot of Xpath details to share with users
so we need some page to put all that details in one place

To do:
create page under
https://checkstyle.org/config.html
with name "XPath" and put here all details and bunch of examples of xpath
links to CLI options, links to filters/checks.

Remove all links to master code from MatchXpath Check, detected at #8902 (comment)

related request for update - #6456

@nrmancuso
Copy link
Member

From #142:

we need to create a searchable repository (conceptually, not necessarily a github repo) of MatchXPath modules with metadata tags and examples like this to help users easily discover such xpath modules.

@romani
Copy link
Member Author

romani commented May 9, 2024

I Propose to use https://checkstyle.org/checks/coding/matchxpath.html#Examples as place for good examples that are like Checks, so user will find description and will see config and it will be checked by build to be actual.


I just tested search of Google on our pages, https://www.google.com/search?q=violate+if+there+are+any+parametrized+constructors&oq=violate+if+there+are+any+parametrized+constructors&gs_lcrp=EgZjaHJvbWUyBggAEEUYOTIJCAEQIRgKGKABMgkIAhAhGAoYoAEyCQgDECEYChigATIHCAQQIRifBdIBCDExMjlqMGo3qAIUsAIB&client=ms-android-google&sourceid=chrome-mobile&ie=UTF-8

For https://checkstyle.org/checks/coding/matchxpath.html#Example2-config

And nothing is found :).
Sad, but still think this page is best location for such examples with low efforts from our side.

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

2 participants