Consensys / vscode-solidity-metrics

Generate Solidity Source Code Metrics, Complexity and Risk profile reports for your project.
https://marketplace.visualstudio.com/items?itemName=tintinweb.solidity-metrics
46 stars 6 forks source link

Readme should provide more info about the metrics and icons used #20

Open webthethird opened 11 months ago

webthethird commented 11 months ago

First off, thanks for the useful tool!

My only problem with it is the lack of information provided in the readme. I saw a few closed issues with questions about how certain metrics are calculated, and I think the answers to these should be summarized in the readme. This info would then also be visible in the extension details in VSCode, since that just shows the readme anyway. In addition to the metrics questions, it would be useful to include a brief glossary of the various emojis used in the Type and Capabilities columns. I suppose it would suffice to give the icons in the Type column a tooltip when hovering over them with the mouse, as is currently done with the Capabilities icons, though a glossary would also tell me what all of the possible capabilities are, whereas currently I only know the two that are present in my codebase.