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

feat: Format signature help when valid docstring style #6649

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

feat: Format signature help when valid docstring style #6649

wants to merge 19 commits into from

Conversation

mofojed
Copy link
Member

@mofojed mofojed commented Feb 14, 2025 •
edited
Loading

  • Closes Markdown formatted autocomplete web-client-ui#2247
  • Adds docstring_parser library for autocomplete usage
  • If a valid docstring is found, format the autocomplete help tooltip with markdown, similar to how VS Code does it
    • Formats the parameters list for readability, and also includes the parameter type and default
    • The current parameter that's being entered has some helpful text at the top (similar to VS Code)
  • Regular docstrings can now use Markdown, but the whitespace style follows plain text
  • Supercedes feat: Format signature help when valid docstring style #6170

wusteven815 and others added 18 commits October 4, 2024 10:18
@wusteven815
format markdown
2d61d54
@wusteven815
update docker server
775a143
@wusteven815
fix requirements
d22070f
@wusteven815
add dynamic signature, clean
0ef6462
@wusteven815
fix requirements
a918695
@wusteven815
add tests
b9df3f5
@wusteven815
fix test
e810344
@wusteven815
parse examples
96f6753
@wusteven815
clean and add comments
3654825
@wusteven815
Merge branch 'main' into formatted-autocomplete-md
f9fd9ed
@wusteven815
Merge branch 'deephaven:main' into formatted-autocomplete-md
77820e4
@wusteven815
Merge branch 'deephaven:main' into formatted-autocomplete-md
3222ac4
@mofojed
Merge remote-tracking branch 'origin/main' into formatted-autocomplet…
c66e1f7 
…e-md
@mofojed
Clean up the tests for docstrings
54fb6b7 
- Rather than duplicating the code, using inspect.get_source you can get the source code. Makes the tests much easier
- Moved everything into one file, a little bit easier to follow.
@mofojed
Clean up some more based on review comments
1d00437
@mofojed
Remove the truncation logic
529e297 
- It was kind of annoying, would rather see all the parameters. That's what VS Code does
@mofojed
Merge remote-tracking branch 'origin/main' into formatted-autocomplet…
c14acc7 
…e-md
@mofojed
Clean up based on self-review
45e5f96
@mofojed mofojed self-assigned this Feb 14, 2025
@mofojed mofojed mentioned this pull request Feb 14, 2025
Closed
@mofojed mofojed added NoDocumentationNeeded NoReleaseNotesNeeded No release notes are needed. labels Feb 14, 2025
@mofojed
Copy link
Member Author

mofojed commented Feb 18, 2025

Before:

image

After:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chipkent chipkent Awaiting requested review from chipkent chipkent is a code owner

@jmao-denver jmao-denver Awaiting requested review from jmao-denver jmao-denver is a code owner

@rcaudy rcaudy Awaiting requested review from rcaudy rcaudy is a code owner

@cpwright cpwright Awaiting requested review from cpwright cpwright is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@mofojed mofojed

Labels
NoDocumentationNeeded NoReleaseNotesNeeded No release notes are needed.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Markdown formatted autocomplete
2 participants
@mofojed @wusteven815