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.

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

add doctests for example 1/n #5079

Merged
merged 9 commits into from
Dec 17, 2020
Merged

add doctests for example 1/n #5079

merged 9 commits into from
Dec 17, 2020

Conversation

Borda
Copy link
Member

@Borda Borda commented Dec 11, 2020

What does this PR do?

We shall at least to instantiate all models in examples with default/minimal parameters

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • 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? Otherwise, we ask you to create a separate PR for every change.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?
  • Did you verify new and existing tests pass locally with your changes?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

PR review

Anyone in the community is free to review the PR once the tests have passed.
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; Bugfixes should be including in bug-fix release milestones (m.f.X) and features should be included in (m.X.b) releases.

Did you have fun?

Make sure you had fun coding 🙃

@Borda Borda added bug Something isn't working example ci Continuous Integration priority: 1 Medium priority task labels Dec 11, 2020
@Borda Borda added this to the 1.1.x milestone Dec 11, 2020
@Borda Borda marked this pull request as ready for review December 11, 2020 10:48
@Borda Borda mentioned this pull request Dec 11, 2020
11 tasks
@Borda Borda changed the title add doctests for example add doctests for example 1/n Dec 11, 2020
@Borda Borda mentioned this pull request Dec 11, 2020
@codecov
Copy link

codecov bot commented Dec 11, 2020

Codecov Report

Merging #5079 (6c00b9e) into master (a94f662) will decrease coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #5079   +/-   ##
======================================
- Coverage      93%     93%   -0%     
======================================
  Files         134     134           
  Lines        9928    9928           
======================================
- Hits         9242    9235    -7     
- Misses        686     693    +7     

Copy link
Member

@justusschock justusschock left a comment

Choose a reason for hiding this comment

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

One minor comm. Else lgtm

pl_examples/bug_report_model.py Outdated Show resolved Hide resolved
@mergify mergify bot requested a review from a team December 12, 2020 14:56
@Borda Borda added the ready PRs ready to be merged label Dec 14, 2020
Borda and others added 9 commits December 17, 2020 10:22
Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
@Borda Borda merged commit 1b599ff into master Dec 17, 2020
@Borda Borda deleted the tests/doctest-examples branch December 17, 2020 10:13
awaelchli pushed a commit that referenced this pull request Dec 18, 2020
* define tests

* fix basic

* fix gans

* unet

* test

* drop

* format

* fix

* revert

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Borda added a commit that referenced this pull request Dec 23, 2020
* define tests

* fix basic

* fix gans

* unet

* test

* drop

* format

* fix

* revert

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Borda added a commit that referenced this pull request Dec 29, 2020
* define tests

* fix basic

* fix gans

* unet

* test

* drop

* format

* fix

* revert

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Borda added a commit that referenced this pull request Jan 4, 2021
* define tests

* fix basic

* fix gans

* unet

* test

* drop

* format

* fix

* revert

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Borda added a commit that referenced this pull request Jan 4, 2021
* define tests

* fix basic

* fix gans

* unet

* test

* drop

* format

* fix

* revert

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Borda added a commit that referenced this pull request Jan 5, 2021
* define tests

* fix basic

* fix gans

* unet

* test

* drop

* format

* fix

* revert

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>

Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ci Continuous Integration example priority: 1 Medium priority task ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants