improvement: support more parameter descriptions, e.g. in polars
#4786
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.13.5-dev21 |
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
Small follow up to #4673.
🔍 Description of Changes
Polars often uses a simplified rst format for parameters where it does not include types.
This requires
docstring-to-markdownv0.17 with:polarspython-lsp/docstring-to-markdown#44For example, before there was only one parameter with description for
polars.io.parquet.functions.read_parquet, and now all 22 are displayed.Parameters from functions with overloads such as
polars.io.database.functions.read_databaseremain without good suggestions.📋 Checklist
📜 Reviewers
@mscolnick