roslynator icon indicating copy to clipboard operation
roslynator copied to clipboard

Missing documentation

Open BenjaminBrienen opened this issue 1 year ago • 7 comments
trafficstars

Documentation does not exist for roslynator_blank_line_between_closing_brace_and_switch_section. In fact, there are 0 search results on Google and DuckDuckGo, but I can see that the config is being used in the codebase.

Also missing for RCS1082 UseCountOrLengthPropertyInsteadOfCountMethod https://josefpihrt.github.io/docs/roslynator/analyzers/RCS1082

And RCS1115 ReplaceReturnStatementWithExpressionStatement https://josefpihrt.github.io/docs/roslynator/analyzers/RCS1115

BenjaminBrienen avatar Mar 14 '24 21:03 BenjaminBrienen

Ad roslynator_blank_line_between_closing_brace_and_switch_section: This option is obsolete as the "parent" analyzer is obsolete. It can be found here: https://josefpihrt.github.io/docs/roslynator/analyzers/RCS0014/

Ad RCS1082, RCS1115: these analyzers were completely removed from Roslynator (usually replaced with or merged into some other analyzer). I would say that there should not be any links to these analyzers. Where does these links come from?

josefpihrt avatar Mar 15 '24 09:03 josefpihrt

Ad roslynator_blank_line_between_closing_brace_and_switch_section: This option is obsolete as the "parent" analyzer is obsolete. It can be found here: https://josefpihrt.github.io/docs/roslynator/analyzers/RCS0014/

Ad RCS1082, RCS1115: these analyzers were completely removed from Roslynator (usually replaced with or merged into some other analyzer). I would say that there should not be any links to these analyzers. Where does these links come from?

I wrote the links manually because I saw the definitions for those in the XML file. I was just trying to create an .editorconfig that enabled absolutely everything with at least a suggestion minimum severity. Every example of a "complete" config file seems to be missing one or two things. The XML file seemed to be the most up to date "source". Thus, I based mine on that, coming across a few discrepancies in the meanwhile.

BenjaminBrienen avatar Mar 15 '24 10:03 BenjaminBrienen

The full list of options is available here: https://josefpihrt.github.io/docs/roslynator/configuration. You just need to choose value for options that can have multiple value and replace analyzer severity for analyzer that are not enabled by default.

Does that help?

josefpihrt avatar Mar 15 '24 11:03 josefpihrt

The full list of options is available here: https://josefpihrt.github.io/docs/roslynator/configuration. You just need to choose value for options that can have multiple value and replace analyzer severity for analyzer that are not enabled by default.

Does that help?

I did find that, but there seemed to be a couple things missing from that list. Maybe it's only the unreleased and deprecated features you mentioned earlier. Thanks! Love the product, by the way. I needed Roslynator to point out unused expression values and many more tiny suggestions. The IDE analyzers aren't the best imo. It works amazingly well!

BenjaminBrienen avatar Mar 15 '24 11:03 BenjaminBrienen

I'm really glad you like it!

josefpihrt avatar Mar 15 '24 12:03 josefpihrt

@josefpihrt this page https://josefpihrt.github.io/docs/roslynator/analyzers/RCS0014/ has a broken link https://josefpihrt.github.io/docs/roslynator/analyzers/RCS0014/RCS0061

BenjaminBrienen avatar Mar 15 '24 12:03 BenjaminBrienen

I know about this issue. Weird is that when you refresh the page the link is correct (at least that is my experience). Maybe it has something to do with Docusaurus, but haven't found out yet. If you have any idea what could be the cause, it would be great.

josefpihrt avatar Mar 15 '24 14:03 josefpihrt