mirror of
https://github.com/github/codeql.git
synced 2025-12-16 16:53:25 +01:00
24a29f46be
In hindsight, having a `.getMetrics()` method that just returns `this` is somewhat weird. It's possible that it predates the existence of the inline cast, however.
21 lines
523 B
Plaintext
21 lines
523 B
Plaintext
/**
|
|
* @name Percentage of docstrings
|
|
* @description The percentage of lines in a file that contain docstrings.
|
|
* @kind treemap
|
|
* @id py/doc-string-ratio-per-file
|
|
* @treemap.warnOn lowValues
|
|
* @metricType file
|
|
* @metricAggregate avg max
|
|
* @tags maintainability
|
|
* documentation
|
|
*/
|
|
|
|
import python
|
|
private import LegacyPointsTo
|
|
|
|
from ModuleMetrics mm
|
|
where mm.getNumberOfLines() > 0
|
|
select mm,
|
|
100.0 * (mm.getNumberOfLinesOfDocStrings().(float) / mm.getNumberOfLines().(float)) as ratio
|
|
order by ratio desc
|