improvement: documentation of parameters as show in the completion box #4673
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 ↗︎
|
|
@krassowski is attempting to deploy a commit to the marimo Team on Vercel. A member of the Team first needs to authorize it. |
mscolnick
reviewed
Apr 25, 2025
marimo/_runtime/patches.py
Outdated
| def patch_jedi_parameter_completion() -> None: | ||
| import re | ||
|
|
||
| from docstring_to_markdown import UnknownFormatError, convert |
There was a problem hiding this comment.
this may not be installed (like in wasm). it is still optional, but pulled in from pylsp. could we put a try catch or use if DependencyManager.docstring_to_markdown.has():
mscolnick
changed the title
4 tasks
mscolnick
added a commit
that referenced
this pull request
May 5, 2025
…4786) ## 📝 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-markdown` v0.17 with: - python-lsp/docstring-to-markdown#44 For 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_database` remain without good suggestions. ## 📋 Checklist - [x] I have read the [contributor guidelines](https://github.com/marimo-team/marimo/blob/main/CONTRIBUTING.md). - [ ] For large changes, or changes that affect the public API: this change was discussed or approved through an issue, on [Discord](https://marimo.io/discord?ref=pr), or the community [discussions](https://github.com/marimo-team/marimo/discussions) (Please provide a link if applicable). - [x] I have added tests for the changes made. - [x] I have run the code and verified that it works as expected. ## 📜 Reviewers @mscolnick --------- Co-authored-by: Myles Scolnick <myles@marimo.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Previously the parameters completions would show up empty or with useless
NoneType()annotation. This PR adds a patch for marimo while awaiting a solution in jedi and/or pylsp. The related upstream issues are:NoneType()for parameters annotated withOptionalin completion davidhalter/jedi#2063🔍 Description of Changes
marimoparameters have documentation extracted by (patched) jedimarimoby jedi so that we use static analysis and can read comments fordataclasses to generate documentationmarimohighlighted by tests📋 Checklist
📜 Reviewers
@mscolnick