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

Use comments as symbol documentation #235

Merged
merged 3 commits into from
May 15, 2020
Merged

Conversation

skovhus
Copy link
Collaborator

@skovhus skovhus commented May 15, 2020

Iteration based on #234 (comments above symbols as documentation for onHover) to also use this feature for onCompletion items.

@codecov
Copy link

codecov bot commented May 15, 2020

Codecov Report

Merging #235 into master will increase coverage by 0.45%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #235      +/-   ##
==========================================
+ Coverage   73.47%   73.92%   +0.45%     
==========================================
  Files          18       18              
  Lines         558      560       +2     
  Branches       90       90              
==========================================
+ Hits          410      414       +4     
  Misses        125      125              
+ Partials       23       21       -2     
Impacted Files Coverage Δ
server/src/server.ts 62.26% <100.00%> (+1.75%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2e02f9b...5df765f. Read the comment docs.

@skovhus
Copy link
Collaborator Author

skovhus commented May 15, 2020

@nikita-skobov I used your work to also return the new symbol documentation when using the onCompletion handler (use for suggestions when writing a symbol matching other symbols in the workspace).

@skovhus skovhus merged commit ae9843a into master May 15, 2020
@skovhus skovhus deleted the comments-as-documentation branch May 15, 2020 06:52
akurtakov added a commit to akurtakov/shellwax that referenced this pull request May 27, 2020
Language server changelog:
1.16.1

    Fix brace expansion bug
(bash-lsp/bash-language-server#240)
    Do not crash if bash is not installed
(bash-lsp/bash-language-server#242)

1.16.0

    Improved completion handler for parameter expansions
(bash-lsp/bash-language-server#237)

1.15.0

    Use comments above symbols for documentation
(bash-lsp/bash-language-server#234,
bash-lsp/bash-language-server#235)

1.14.0

    onHover and onCompletion documentation improvements
(bash-lsp/bash-language-server#230)
    support 0/1 as values for HIGHLIGHT_PARSING_ERRORS
(bash-lsp/bash-language-server#231)

1.13.1

    Gracefully handle glob failures
(bash-lsp/bash-language-server#224,
bash-lsp/bash-language-server#226)
    Maintenance
(bash-lsp/bash-language-server#222,
bash-lsp/bash-language-server#225)


Signed-off-by: Alexander Kurtakov <[email protected]>
akurtakov added a commit to eclipse-shellwax/shellwax that referenced this pull request May 27, 2020
Language server changelog:
1.16.1

    Fix brace expansion bug
(bash-lsp/bash-language-server#240)
    Do not crash if bash is not installed
(bash-lsp/bash-language-server#242)

1.16.0

    Improved completion handler for parameter expansions
(bash-lsp/bash-language-server#237)

1.15.0

    Use comments above symbols for documentation
(bash-lsp/bash-language-server#234,
bash-lsp/bash-language-server#235)

1.14.0

    onHover and onCompletion documentation improvements
(bash-lsp/bash-language-server#230)
    support 0/1 as values for HIGHLIGHT_PARSING_ERRORS
(bash-lsp/bash-language-server#231)

1.13.1

    Gracefully handle glob failures
(bash-lsp/bash-language-server#224,
bash-lsp/bash-language-server#226)
    Maintenance
(bash-lsp/bash-language-server#222,
bash-lsp/bash-language-server#225)


Signed-off-by: Alexander Kurtakov <[email protected]>
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.

1 participant