Skip to content

Small Adjustments related to Markdown format Docs #714

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

Merged
merged 2 commits into from
Aug 30, 2025
Merged

Small Adjustments related to Markdown format Docs #714

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cbcc30
Small phrasing adustments in Markdown docs
marcosboger Aug 30, 2025
6239948
Add GitHub Actions example and fix example to not break with default …
marcosboger Aug 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/reporting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Reporting

It is possible to generate any combination of the reports for a single test run.

The available reports are terminal (with or without missing line numbers shown), HTML, XML, JSON, MARKDOWN (either in 'write' or 'append' mode to file), LCOV and
The available reports are terminal (with or without missing line numbers shown), HTML, XML, JSON, Markdown (either in 'write' or 'append' mode to file), LCOV and
annotated source code.

The terminal report without line numbers (default)::
Expand Down Expand Up @@ -49,19 +49,20 @@ The terminal report with skip covered::

You can use ``skip-covered`` with ``term-missing`` as well. e.g. ``--cov-report term-missing:skip-covered``

These seven report options output to files without showing anything on the terminal::
The report options below output to files without showing anything on the terminal::

pytest --cov-report html
--cov-report xml
--cov-report json
--cov-report markdown
--cov-report markdown-append
--cov-report markdown-append:cov-append.md
--cov-report lcov
--cov-report annotate
--cov=myproj tests/

The output location for each of these reports can be specified. The output location for the XML, JSON, MARKDOWN and LCOV
report is a file. Where as the output location for the HTML and annotated source code reports are
The output location for each of these reports can be specified. The output location for the XML, JSON, Markdown and LCOV
report is a file. markdown-append option is specially useful for appending the report to an existing file. Example for GitHub Actions:
--cov-report=markdown-append:${GITHUB_STEP_SUMMARY}. Where as the output location for the HTML and annotated source code reports are
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backticks missing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the --cov-report=markdown-append:${GITHUB_STEP_SUMMARY command, right?

@ionelmc makes sense an extra PR for this small fix too?

directories::

pytest --cov-report html:cov_html
Expand Down
Loading