/**
 * @name Percentage of comments
 * @description The percentage of lines in a file that contain comments. Note that docstrings are
 *              reported by a separate metric.
 * @kind treemap
 * @id py/comment-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.getNumberOfLinesOfComments().(float) / mm.getNumberOfLines().(float)) as ratio
  order by ratio desc