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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation for callbacks #4253

Merged
merged 1 commit into from Oct 20, 2020
Merged

update documentation for callbacks #4253

merged 1 commit into from Oct 20, 2020

Conversation

tchaton
Copy link
Contributor

@tchaton tchaton commented Oct 20, 2020

What does this PR do?

In callbacks.rst, we were listing ModelHooks functions and not Callback class hooks.

This PR rectify the documentation.

Fixes # (issue)

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.
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 馃檭

@mergify mergify bot requested a review from a team October 20, 2020 11:54
@codecov
Copy link

codecov bot commented Oct 20, 2020

Codecov Report

Merging #4253 into master will increase coverage by 3%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #4253    +/-   ##
=======================================
+ Coverage      90%     93%    +3%     
=======================================
  Files         103     103            
  Lines        7842    7842            
=======================================
+ Hits         7053    7275   +222     
+ Misses        789     567   -222     

@ydcjeff ydcjeff added bug Something isn't working docs Documentation related labels Oct 20, 2020
@tchaton tchaton added the ready PRs ready to be merged label Oct 20, 2020
@mergify mergify bot requested a review from a team October 20, 2020 14:21
@SeanNaren SeanNaren merged commit 09c2f4a into master Oct 20, 2020
@SeanNaren SeanNaren deleted the bugfix/doc_callbacks branch October 20, 2020 15:01
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 ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants