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

Fix docs - missing Trainer #1159

Merged
merged 2 commits into from
Mar 15, 2020
Merged

Fix docs - missing Trainer #1159

merged 2 commits into from
Mar 15, 2020

Conversation

Borda
Copy link
Member

@Borda Borda commented Mar 15, 2020

What does this PR do?

Fixes missing Trainer docs.

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@Borda Borda added bug Something isn't working docs Documentation related labels Mar 15, 2020
@Borda Borda added this to the 0.7.2 milestone Mar 15, 2020
@Borda Borda requested a review from williamFalcon March 15, 2020 23:34
@pep8speaks
Copy link

Hello @Borda! Thanks for opening this PR.

Line 219:101: E501 line too long (111 > 100 characters)

Do see the Hitchhiker's guide to code style

@awaelchli
Copy link
Contributor

Do you know if it is possible to test the docs as part of the CI? Sometimes people don't check that the docs compile or don't see the warnings. Otherwise things like this will happen again and need to be fixed by someone else :(

@williamFalcon williamFalcon merged commit 774d9be into master Mar 15, 2020
@codecov
Copy link

codecov bot commented Mar 15, 2020

Codecov Report

Merging #1159 into master will decrease coverage by <1%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #1159    +/-   ##
=======================================
- Coverage      93%     93%   -<1%     
=======================================
  Files          61      61            
  Lines        2672    2670     -2     
=======================================
- Hits         2472    2470     -2     
  Misses        200     200

@Borda Borda deleted the fix-docs branch March 16, 2020 00:04
@Borda
Copy link
Member Author

Borda commented Mar 16, 2020

Do you know if it is possible to test the docs as part of the CI? Sometimes people don't check that the docs compile or don't see the warnings. Otherwise things like this will happen again and need to be fixed by someone else :(

yes, we already had this discussion before v0.7.1 but then there was much other work...
we already have it in CI but the problem is that these errors do not crash the building process
https://app.circleci.com/pipelines/github/PyTorchLightning/pytorch-lightning/1369/workflows/4123ff8a-8117-4ad5-83db-6e01d9e061ea/jobs/9335
I was checking for a solution which would raise warning as errors but has not found it yet
in our case, the problem is mostly in autodoc that it fails on bad imports or syntax...

tullie pushed a commit to tullie/pytorch-lightning that referenced this pull request Apr 3, 2020
@Borda Borda modified the milestones: v0.7., v0.7.x Apr 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants