Doctor v0.11.0 Doctor.ReportUtils View Source

This module provides some utility functions for use in report generators.

Link to this section Summary

Functions

Calculate the overal doc coverage in the codebase

Calculate the overal spec coverage in the codebase

Given a list of module reports, count the total number of documented functions

Given a list of module reports, count the total number of failed modules

Given a list of module reports, count the total number of functions

Given a list of module reports, count the total number of passed modules

Given a list of module reports, count the total number of speced functions

Check whether Doctor overall has passed or failed validation

Checks whether the provided module passed validation

Link to this section Functions

Link to this function

calc_overall_doc_coverage(module_report_list) View Source

Calculate the overal doc coverage in the codebase

Link to this function

calc_overall_spec_coverage(module_report_list) View Source

Calculate the overal spec coverage in the codebase

Link to this function

count_total_documented_functions(module_report_list) View Source

Given a list of module reports, count the total number of documented functions

Link to this function

count_total_failed_modules(module_report_list, config) View Source

Given a list of module reports, count the total number of failed modules

Link to this function

count_total_functions(module_report_list) View Source

Given a list of module reports, count the total number of functions

Link to this function

count_total_passed_modules(module_report_list, config) View Source

Given a list of module reports, count the total number of passed modules

Link to this function

count_total_speced_functions(module_report_list) View Source

Given a list of module reports, count the total number of speced functions

Link to this function

doctor_report_passed?(module_report_list, config) View Source

Check whether Doctor overall has passed or failed validation

Link to this function

module_passed_validation?(module_report, config) View Source

Checks whether the provided module passed validation