doc: add type hints #292
Merged
doc: add type hints #292
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
Signed-off-by: Benjamin Gilbert <[email protected]>
Several properties return tuples of items but are documented to return lists. Fix the docs. Signed-off-by: Benjamin Gilbert <[email protected]>
Drop some redundant description text. Don't document the types of the standard OpenSlide property names, since they're all strings and would clutter the list. Signed-off-by: Benjamin Gilbert <[email protected]>
Remove type information from parameter documentation, since it's redundant now. Signed-off-by: Benjamin Gilbert <[email protected]>
It's used in the type signature of the DeepZoomGenerator constructor because DeepZoomGenerator also supports user-supplied AbstractSlide subclasses. Ensure the hyperlink has somewhere to point, and update the DeepZoomGenerator description to mention user-provided implementations. Signed-off-by: Benjamin Gilbert <[email protected]>
No rendering changes intended. Signed-off-by: Benjamin Gilbert <[email protected]>
DCO signed off ✔️All commits have been signed off. You have certified to the terms of the Developer Certificate of Origin, version 1.1. In particular, you certify that this contribution has not been developed using information obtained under a non-disclosure agreement or other license terms that forbid you from contributing it under the GNU Lesser General Public License, version 2.1. |
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.
Document
AbstractSlide; it's used in the type signature of theDeepZoomGeneratorconstructor becauseDeepZoomGeneratoralso supports user-suppliedAbstractSlidesubclasses. Update theDeepZoomGeneratordescription to mention user-provided implementations.Also several cleanups.