pFad - Phone/Frame/Anonymizer/Declutterfier! Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

URL: http://github.com/python-lsp/python-lsp-server/pull/686

lobal-1543fa0fa07515a5.css" /> Add option to hide docstring in signatures by tomekwojcik · Pull Request #686 · python-lsp/python-lsp-server · GitHub
Skip to content

Add option to hide docstring in signatures#686

Merged
ccordoba12 merged 2 commits intopython-lsp:developfrom
tomekwojcik:allow_signature_to_hide_docstrings
Dec 6, 2025
Merged

Add option to hide docstring in signatures#686
ccordoba12 merged 2 commits intopython-lsp:developfrom
tomekwojcik:allow_signature_to_hide_docstrings

Conversation

@tomekwojcik
Copy link
Contributor

Both jedi_hover and jedi)signature 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 signature docstrings by adding a config flag. It defaults 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
Copy link
Contributor Author

This PR is updated version of #589.

Copy link
Member

@ccordoba12 ccordoba12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of suggestions for you @tomekwojcik, the rest looks good to me.

Also, please rebase on top of develop to run our tests with newer Python versions.

@ccordoba12 ccordoba12 changed the title Allow *signature* to hide the docstring. Allow signature to hide the docstring Dec 4, 2025
@ccordoba12 ccordoba12 changed the title Allow signature to hide the docstring Allow signature to hide docstring Dec 4, 2025
@tomekwojcik tomekwojcik force-pushed the allow_signature_to_hide_docstrings branch from 5a50b50 to d5788b5 Compare December 5, 2025 09:58
@tomekwojcik
Copy link
Contributor Author

Thanks for your comments, @ccordoba12. I implemented the changes you requested and rebased on top of develop.

@ccordoba12 ccordoba12 added this to the v1.13.3 milestone Dec 5, 2025
@ccordoba12 ccordoba12 added the enhancement New feature or request label Dec 5, 2025
@ccordoba12 ccordoba12 changed the title Allow signature to hide docstring Add option to hide docstring in signatures Dec 6, 2025
Copy link
Member

@ccordoba12 ccordoba12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now, thanks @tomekwojcik for your contribution!

@ccordoba12 ccordoba12 merged commit 4ebece5 into python-lsp:develop Dec 6, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

pFad - Phonifier reborn

Pfad - The Proxy pFad © 2024 Your Company Name. All rights reserved.





Check this box to remove all script contents from the fetched content.



Check this box to remove all images from the fetched content.


Check this box to remove all CSS styles from the fetched content.


Check this box to keep images inefficiently compressed and original size.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy