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

Missing documentation #1423

Open
BenjaminBrienen opened this issue Mar 14, 2024 · 7 comments
Open

Missing documentation #1423

BenjaminBrienen opened this issue Mar 14, 2024 · 7 comments

Comments

@BenjaminBrienen
Copy link

BenjaminBrienen commented Mar 14, 2024

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

@josefpihrt
Copy link
Collaborator

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?

@BenjaminBrienen
Copy link
Author

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.

@josefpihrt
Copy link
Collaborator

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?

@BenjaminBrienen
Copy link
Author

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!

@josefpihrt
Copy link
Collaborator

I'm really glad you like it!

@josefpihrt
Copy link
Collaborator

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.

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