FilesExpand file tree

codeql-cli/v2.27.2

/

DocStringRatio.ql

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

19 lines (17 loc) · 493 Bytes

codeql-cli/v2.27.2

/

DocStringRatio.ql

Copy path

Top

File metadata and controls

• Code
• Blame

19 lines (17 loc) · 493 Bytes

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

/**

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