Dedupe ImageGrid doc from tutorial and docstring. #16372
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ImageGrid is so little-maintained that I don't think we should have duplicate argument lists in the tutorial and the docstring, given that they *will* go out of sync (for more commonly used APIs, sure, we can maintain the duplication, but here it's not worth it). Add to the docstring the relevant parts of the tutorial, and make the tutorial point to the API docs.
Codecov Report
@@ Coverage Diff @@
## master #16372 +/- ##
==========================================
- Coverage 80.85% 80.10% -0.76%
==========================================
Files 307 307
Lines 75745 75745
Branches 9690 9690
==========================================
- Hits 61245 60674 -571
- Misses 11961 12561 +600
+ Partials 2539 2510 -29
Continue to review full report at Codecov.
|
timhoffm
approved these changes
Feb 1, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ImageGrid is so little-maintained that I don't think we should have
duplicate argument lists in the tutorial and the docstring, given that
they will go out of sync (for more commonly used APIs, sure, we can
maintain the duplication, but here it's not worth it). Add to the
docstring the relevant parts of the tutorial, and make the tutorial
point to the API docs.
Closes #16371.
PR Summary
PR Checklist