Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix RsT edge cases to better support polars #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 2, 2025

Conversation

krassowski
Copy link
Member

This improves support for polars docstrings

@krassowski krassowski merged commit e3f944f into python-lsp:main May 2, 2025
8 checks passed
mscolnick added a commit to marimo-team/marimo 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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant