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

explain metrics with more details #239

Open
yegor256 opened this issue Mar 21, 2024 · 2 comments
Open

explain metrics with more details #239

yegor256 opened this issue Mar 21, 2024 · 2 comments
Labels
bug Something isn't working help wanted Extra attention is needed

Comments

@yegor256
Copy link
Owner

Let's improve the details of some metrics:

  • DOER
  • FOUT
  • HSD, HSE, HSV
  • MIDX
  • NCSS
  • NULLS

Currently, they are very sketchy, which makes it hard to use them.

@yegor256 yegor256 added bug Something isn't working help wanted Extra attention is needed labels Mar 21, 2024
@LaithAlebrahim
Copy link
Contributor

LaithAlebrahim commented Mar 25, 2024

@yegor256 Just quick question , Should I document and details the metrics in ast.py or add the details to somewhere else.Thanks

@yegor256
Copy link
Owner Author

@LaithAlebrahim each of these metrics print their "details" as an output, for example in this line: https://github.com/yegor256/cam/blob/master/metrics/ast.py#L456 The output is " Data vs Object Encapsulation Ratio" -- this is not enough to understand what DOER metric is about. We should print a much more detailed explanation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants