search

yegor256 / cam

Classes and Metriсs (CaM): a dataset of Java classes from public open-source GitHub repositories
http://cam.yegor256.com
MIT License
23 stars 30 forks source link

explain metrics with more details #239

Open yegor256 opened 5 months ago

yegor256 commented 5 months ago

Let's improve the details of some metrics:

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

LaithAlebrahim commented 5 months ago

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

yegor256 commented 5 months ago

@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.