Skip to content

Allow jedi_hover and jedi_signature_help plugins to hide docstrings. #589

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

tomekwojcik
Copy link

Both the plugins include a signature's docstring by the default in the content they generate. Which is cool, as long as the docstring's author doesn't moonlight as a novelist. Otherwise, the content rendered in the popup will cover the entire screen. It's annoying to say the least.

This changeset allows a user to hide the docstrings by adding config flags. They default to true so people aren't surprised by the change. I've been running this version in ST4 with no issues for a while, so I'm submitting it as a PR.

@tomekwojcik tomekwojcik force-pushed the allow_hover_and_sig_help_to_hide_docstrings branch 2 times, most recently from 3779896 to 69129b9 Compare June 20, 2025 13:57
@krassowski
Copy link
Member

Just wondering if this should be a setting on pylsp.signature level rather than two settings one individual method levels... Any thoughts on it?

@tomekwojcik
Copy link
Author

Just wondering if this should be a setting on pylsp.signature level rather than two settings one individual method levels... Any thoughts on it?

I added two separate settings to allow for greater customization. Somebody might be fine with the docstring in hover popup, but not so much in signature help (when the cursor's between ()).

Personally, I'd lean towards a single setting. I have both of them set to False anyways :).

@tomekwojcik tomekwojcik force-pushed the allow_hover_and_sig_help_to_hide_docstrings branch from 69129b9 to 494adc1 Compare June 26, 2025 20:37
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.

2 participants