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.

Sign up for GitHub

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

Jump to bottom

Improve parameter doc parsing #773

Closed
zooba opened this issue Aug 20, 2015 · 2 comments
Closed

Improve parameter doc parsing #773

zooba opened this issue Aug 20, 2015 · 2 comments
Labels
enhancement

Comments

@zooba
Copy link
Member

zooba commented Aug 20, 2015

Currently we trim documentation for signature help to the first paragraph or 15 (or so) lines in order to make it fit. There is no documentation displayed for parameters.

We should more intelligently parse docstrings so that we can display the parts of the docstring that relate to each parameter, and more accurately identify the string for the tooltip.
@zooba zooba added this to the 3.0 milestone Aug 20, 2015
@zooba
Copy link
Member Author

zooba commented Aug 20, 2015

At a minimum, this should handle ReST and the numpy formats correctly. More abstract formats, including prose, don't have to be perfect, but shouldn't be any worse than they are now.

@zooba zooba mentioned this issue Aug 20, 2015
Closed
@zooba zooba mentioned this issue Sep 4, 2015
Closed
@zooba zooba modified the milestone: 3.0 Feb 24, 2017
@huguesv
Copy link
Contributor

huguesv commented Oct 24, 2018

We're closing old issues with no recent activity. If this is still important, please open a new issue.

@huguesv huguesv closed this as completed Oct 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@zooba @huguesv