Add helper function to explain general_metadata queries#1174
Open
vshnvii wants to merge 1 commit intomalariagen:masterfrom
Open
Add helper function to explain general_metadata queries#1174vshnvii wants to merge 1 commit intomalariagen:masterfrom
vshnvii 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
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.
Summary
This PR introduces a helper function to explain what the
general_metadataquery does in a simple and user-friendly way.Motivation
While exploring the malariagen_data API, I noticed that understanding what a function does may not always be straightforward, especially for users who are not very familiar with the codebase or programming in general.
This small addition aims to improve usability by providing a way to quickly understand what kind of data is being retrieved and what the query represents.
Changes
explain_general_metadata_queryExample