Skip to content

Use source_pkgs in the adhoc layout example #762

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

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

Use source_pkgs in the adhoc layout example #762

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion examples/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ These examples provide necessary configuration to:

The `adhoc` layout is the old and problematic layout where you can mix up the installed code
with the source code. However, these examples will provide correct configuration even for
the `adhoc` layout.
the `adhoc` layout. Its coverage configuration uses ``source_pkgs = example`` to measure
the installed package without also measuring unrelated files in the test directory.
The ``changedir = tests`` setting is still needed to keep the source checkout out of
Python's import path, so tests exercise the installed package.

The `src` layout configuration is less complicated, have that in mind when picking a layout
for your project.
4 changes: 1 addition & 3 deletions examples/adhoc-layout/.coveragerc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ source =

[run]
branch = true
source =
example
.
source_pkgs = example

[report]
precision = 2
Expand Down