Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP, ENH: add docstring cov to html #808

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

WIP, ENH: add docstring cov to html #808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions coverage/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ def __init__(self):
self.extra_css = None
self.html_dir = "htmlcov"
self.html_title = "Coverage report"
self.html_docstr = False

# Defaults for [xml]
self.xml_output = "coverage.xml"
Expand Down Expand Up @@ -353,6 +354,7 @@ def from_file(self, filename, our_file):
('extra_css', 'html:extra_css'),
('html_dir', 'html:directory'),
('html_title', 'html:title'),
('html_docstr', 'html:docstring_display'),

# [xml]
('xml_output', 'xml:output'),
Expand Down
7 changes: 7 additions & 0 deletions coverage/html.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,13 @@ def html_file(self, fr, analysis):
)
elif lineno in analysis.statements:
line_class.append(c_run)
elif self.config.html_docstr:
# count docstring line as "executed"
# doctest SKIP directives will not
# prevent a line from being marked
# as executed, but will influence
# the associated source code proper
line_class.append(c_run)

# Build the HTML for the line.
html = []
Expand Down