dotnet / roslynator

Roslynator is a set of code analysis tools for C#, powered by Roslyn.

Home Page:https://josefpihrt.github.io/docs/roslynator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Missing documentation

BenjaminBrienen opened this issue · comments

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

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?

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.

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?

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!

I'm really glad you like it!

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.