Skip to content
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

Add hide docstring functionality #217

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

CeleritasCelery
Copy link
Contributor

Some function and variables (like ivy-read or company-backends) have very large docstrings. These are nicely formatted in the Documentation heading, but then when you get done reading that, you see the same thing show up again in the Source Code heading. There really isn't a need to show the docstring twice, so I added a variable that will remove the docstring from the source code section. I tested it with many different symbols and the only place it does not work is when the docstring adds escapes to non-meta characters (like ( and )).

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.4%) to 76.611% when pulling e52bab7 on CeleritasCelery:docstring into 8ac851e on Wilfred:master.

@rgrinberg
Copy link

This would be quite nice to have. @Wilfred any chance to consider this?

slotThe pushed a commit to slotThe/helpful that referenced this pull request Oct 5, 2023
slotThe pushed a commit to slotThe/helpful that referenced this pull request Oct 5, 2023
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.

3 participants