Add describe_method() for parameter-level API introspection#1267
Open
anushkaxg wants to merge 1 commit intomalariagen:masterfrom
Open
Add describe_method() for parameter-level API introspection#1267anushkaxg wants to merge 1 commit intomalariagen:masterfrom
anushkaxg wants to merge 1 commit intomalariagen:masterfrom
Conversation
|
Hi @anushkaxg , I noticed that you’ve linked this PR to issue #1262 , which I originally opened. I created PR #1263 as a starting point to improve discoverability for AI agents and implemented a It would have been useful to mention my PR in yours, since it already addresses the same issue. Could you clarify how this PR improves upon mine and why it closes the issue? I’d like to avoid duplicating effort and make sure we’re both aligning with the maintainers’ expectations. |
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
Closes #1262
This PR adds a new
describe_method()API onAnophelesDescribeto improve method discoverability for users and agents.describe_method(method: str)returns apandas.DataFramewith one row per parameter and the following columns:parametertypedefaultdescriptionThis complements
describe_api(), which lists methods at a high level.What changed
Implementation
describe_method()tomalariagen_data/anoph/describe.py.ValueError)ValueError)ValueError)Tests
Updated
tests/anoph/test_describe.pywith coverage for:describe_method()selffrom outputdescribe_api -> category)Notes
Nonewhen no default is defined.Example usage