Whats the rule for creating the documentation URL of a check? #13751
Replies: 1 comment 6 replies
-
Just to warn, the URL pathing you shown above is something that was just recently introduced and is still pretty new. I don't think it plans to change soon, but this makes more sense to me to request this as an additional parameter in the metadata that we provide a link to our own documentation. Our meta doesn't include our examples, so this makes a link to documentation more useful. To answer your question as best I can, the URL to the misc section is https://checkstyle.org/checks/misc/index.html . If your trying to identify which checks are misc and which aren't, there isn't anything concrete. For example, it looks like majority of misc checks are located in https://github.com/checkstyle/checkstyle/tree/master/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks , but indentation isn't stored in that area which are also misc. They are located in https://github.com/checkstyle/checkstyle/tree/master/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/indentation . I am not seeing anything in the XML file themselves that clearly says "This is misc and not its own category". You could get away with using the path in |
Beta Was this translation helpful? Give feedback.
-
I'm currently working on providing online help for violations in EclipseCS. For that, I'm calculating the URL dynamically from the checkstyle metadata. E.g. in the sources all paths like checks/javadoc/JavadocMethodCheck.xml can easily be converted to the matching URL https://checkstyle.org/checks/javadoc/javadocmethod.html#JavadocMethod etc., but for the "misc" category this isn't true, since there is no misc in the sources.
Anyone who knows the scheme for mapping checks to URLs?
Beta Was this translation helpful? Give feedback.
All reactions