-
Notifications
You must be signed in to change notification settings - Fork 6
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
Clarify initial setup steps #58
Comments
Agreed. For what it's worth, most of the poor ratings came before I made the landing page a lot more clear. But overall, if the plugin better guided a user through what they needed to do (such that you didn't really need to refer to docs) that would probably be best. When I initially wrote this plugin I was new to IntelliJ plugins and wrote this one based on an existing Cpplint plugin that followed a similar usage flow. I think this workflow could definitely be improved with some more digging into what IntelliJ offers (years later). |
I am planning on making the configuration regarding the The enhanced error balloon should probably also help in some situations. I also have a document ready which covers most of the known issues in detail as well as offering some workaround. That should hopefully resolve some user issues as well. While I was writing that I actually thought of lots of things which resulted in those past few issues I added. I am still not sure how to integrate it with the plugin description for the CLion repository though. |
* README.md: documented `Show Cppcheck XML Output` action and its limitations * README.md: re-wrote "Known Issues" section * some minor documentation improvements * README.md: use proper capitalization for `Cppcheck` and do not quote it * README.md: rewrote `Installation` section - refs #58
The plugin has just an average rating at https://plugins.jetbrains.com/plugin/8143-cppcheck/reviews.
It seems most of them stem from the documentation for the initial setup being confusing. We need to figure out what confuses people and improve the documentation accordingly. Maybe even rewrite it from scratch.
The text was updated successfully, but these errors were encountered: