mirror of
https://github.com/github/codeql.git
synced 2025-12-23 04:06:37 +01:00
f07a7bf8cf
Will need subsequent PRs fixing up test failures (due to deprecated methods moving around), but other than that everything should be straight-forward.
20 lines
526 B
Plaintext
20 lines
526 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 Module m, ModuleMetrics mm
|
|
where mm = m.getMetrics() and mm.getNumberOfLines() > 0
|
|
select m,
|
|
100.0 * (mm.getNumberOfLinesOfDocStrings().(float) / mm.getNumberOfLines().(float)) as ratio
|
|
order by ratio desc
|