Skip to content

fix typos in validation_step and test_step docs#5438

Merged
tchaton merged 4 commits intoLightning-AI:masterfrom
thepooons:fix_lit_docs
Jan 11, 2021
Merged

fix typos in validation_step and test_step docs#5438
tchaton merged 4 commits intoLightning-AI:masterfrom
thepooons:fix_lit_docs

Conversation

@thepooons
Copy link
Copy Markdown
Contributor

@thepooons thepooons commented Jan 9, 2021 •
edited
Loading

What does this PR do?

Fixes #5436 <- this links related issue to this PR

Before submitting

  • 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?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

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
  • Check that target branch and milestone match!

Did you have fun?

Yes, it ain't much but it's honest work.

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 9, 2021 •
edited
Loading

Codecov Report

Merging #5438 (336f862) into master (f1e28d1) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #5438   +/-   ##
======================================
  Coverage      93%     93%           
======================================
  Files         135     135           
  Lines       10011   10011           
======================================
  Hits         9328    9328           
  Misses        683     683

@awaelchli awaelchli added the docs Documentation related label Jan 9, 2021
@awaelchli awaelchli added this to the 1.1.x milestone Jan 9, 2021
@awaelchli awaelchli changed the title fixed docs in lightning.py fix typos in docs of LightningModule.test_step Jan 9, 2021
@awaelchli awaelchli changed the title fix typos in docs of LightningModule.test_step fix typos in validation_step and test_step docs Jan 9, 2021
@awaelchli awaelchli enabled auto-merge (squash) January 9, 2021 16:31
carmocca
carmocca approved these changes Jan 9, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

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

Thanks for the honest work! :D

@rohitgr7 rohitgr7 added the ready to be merged PRs ready to be merged label Jan 10, 2021
@tchaton tchaton disabled auto-merge January 11, 2021 11:02
@tchaton tchaton merged commit 499d503 into Lightning-AI:master Jan 11, 2021
SeanNaren pushed a commit that referenced this pull request Jan 12, 2021
@thepooons @rohitgr7 @SkafteNicki
fix typos in validation_step and test_step docs (#5438)
8f109ae 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
SeanNaren pushed a commit that referenced this pull request Jan 12, 2021
@thepooons @rohitgr7 @SkafteNicki
fix typos in validation_step and test_step docs (#5438)
da0236e 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
@thepooons thepooons deleted the fix_lit_docs branch January 13, 2021 05:04
SeanNaren pushed a commit that referenced this pull request Jan 13, 2021
@thepooons @rohitgr7 @SkafteNicki
fix typos in validation_step and test_step docs (#5438)
376905e 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
SeanNaren pushed a commit that referenced this pull request Jan 13, 2021
@thepooons @rohitgr7 @SkafteNicki
fix typos in validation_step and test_step docs (#5438)
81dcc21 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
SeanNaren pushed a commit that referenced this pull request Jan 19, 2021
@thepooons @rohitgr7 @SkafteNicki
fix typos in validation_step and test_step docs (#5438)
ddcc1d2 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
Borda pushed a commit that referenced this pull request Jan 23, 2021
@thepooons @rohitgr7
@SkafteNicki @Borda
fix typos in validation_step and test_step docs (#5438)
bfd54f1 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
Borda pushed a commit that referenced this pull request Jan 25, 2021
@thepooons @rohitgr7
@SkafteNicki @Borda
fix typos in validation_step and test_step docs (#5438)
4ca0774 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
Borda pushed a commit that referenced this pull request Jan 26, 2021
@thepooons @rohitgr7
@SkafteNicki @Borda
fix typos in validation_step and test_step docs (#5438)
813c960 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
Borda pushed a commit that referenced this pull request Jan 26, 2021
@thepooons @rohitgr7
@SkafteNicki @Borda
fix typos in validation_step and test_step docs (#5438)
f1c3d0c 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
Borda pushed a commit that referenced this pull request Jan 26, 2021
@thepooons @rohitgr7
@SkafteNicki @Borda
fix typos in validation_step and test_step docs (#5438)
defbeec 
* fixed docs in lightning.py

* few more

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
(cherry picked from commit 499d503)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tchaton tchaton tchaton approved these changes

@justusschock justusschock justusschock approved these changes

@SkafteNicki SkafteNicki SkafteNicki approved these changes

@williamFalcon williamFalcon Awaiting requested review from williamFalcon

+4 more reviewers

@awaelchli awaelchli awaelchli approved these changes

@carmocca carmocca carmocca approved these changes

@rohitgr7 rohitgr7 rohitgr7 approved these changes

@s-rog s-rog s-rog approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation related ready to be merged PRs ready to be merged

Projects

None yet

Milestone

pl:1.1.x

Development

Successfully merging this pull request may close these issues.

Errors in documentation generated from lightning.py

8 participants

@thepooons @awaelchli @carmocca @tchaton @justusschock @SkafteNicki @rohitgr7 @s-rog