Skip to content

Exclude docs/ from default pytest directories #10078

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.

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 3 commits into from
Nov 1, 2021

Conversation

akihironitta
Copy link
Contributor

What does this PR do?

Follow-up to #10012.

Problem

VS Code collects tests with:

$ pytest -- --rootdir ~/work/github.com/PyTorchLightning/pytorch-lightning -s --cache-clear

and it fails as the command unexpectedly runs docs/source/conf.py.

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • [n/a] Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • [n/a] Did you make sure to update the documentation with your changes? (if necessary)
  • [n/a] Did you write any new necessary tests? (not for typos and docs)
  • [n/a] Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • [n/a] Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

Additional context

I'm moving from Emacs to VS Code and trying to setup my dev env :)

@Borda
Copy link
Member

Borda commented Oct 22, 2021

but we have some tests there, right?

@codecov
Copy link

codecov bot commented Oct 22, 2021

Codecov Report

Merging #10078 (3294eca) into master (6609b2e) will increase coverage by 4%.
The diff coverage is n/a.

❗ Current head 3294eca differs from pull request most recent head d53a05a. Consider uploading reports for the commit d53a05a to get more accurate results

@@           Coverage Diff            @@
##           master   #10078    +/-   ##
========================================
+ Coverage      89%      92%    +4%     
========================================
  Files         182      182            
  Lines       16431    16115   -316     
========================================
+ Hits        14568    14898   +330     
+ Misses       1863     1217   -646     

@akihironitta
Copy link
Contributor Author

akihironitta commented Oct 22, 2021

I've just made sure locally that make doctest runs doctest in docs/* with the config updated in this PR, so make doctest is independent from setup.cfg changed here.

@mergify mergify bot added the ready PRs ready to be merged label Oct 22, 2021
@awaelchli awaelchli enabled auto-merge (squash) November 1, 2021 14:50
@awaelchli awaelchli merged commit 7ad0ac5 into master Nov 1, 2021
@awaelchli awaelchli deleted the tests/update-pytes-config branch November 1, 2021 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants