mirror of
https://github.com/github/codeql.git
synced 2026-03-30 20:28:15 +02:00
e8de8433f4
The ones that no longer require points-to no longer import `LegacyPointsTo`. The ones that do use the specific `...MetricsWithPointsTo` classes that are applicable.
20 lines
493 B
Plaintext
20 lines
493 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
|
|
|
|
from ModuleMetrics mm
|
|
where mm.getNumberOfLines() > 0
|
|
select mm,
|
|
100.0 * (mm.getNumberOfLinesOfDocStrings().(float) / mm.getNumberOfLines().(float)) as ratio
|
|
order by ratio desc
|