mirror of
https://github.com/github/codeql.git
synced 2025-12-17 01:03:14 +01:00
Initial commit of Python queries and QL libraries.
This commit is contained in:
committed by
Mark Shannon
parent
90c75cd362
commit
5f58824d1b
17
python/ql/src/Metrics/DocStringRatio.ql
Normal file
17
python/ql/src/Metrics/DocStringRatio.ql
Normal file
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* @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 * ((float)mm.getNumberOfLinesOfDocStrings() / (float)mm.getNumberOfLines()) as ratio
|
||||
order by ratio desc
|
||||
Reference in New Issue
Block a user