Docs: Add type hints and examples to cross_metadata docstring#1216
Open
abdullahiftikharcode wants to merge 1 commit intomalariagen:masterfrom
Open
Docs: Add type hints and examples to cross_metadata docstring#1216abdullahiftikharcode wants to merge 1 commit intomalariagen:masterfrom
abdullahiftikharcode wants to merge 1 commit intomalariagen:masterfrom
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR improves the documentation and typing for the
cross_metadatamethod insideAg3. Specifically it:-> pd.DataFramereturn type hint to improve developer tooling/IDE support.Examplessection to the numpy-style docstring demonstrating standard usage, bringing it up to parity with other public methods in the API.Changes Made
malariagen_data/ag3.pyTesting