This repository was archived by the owner on Apr 14, 2022. It is now read-only.
[WIP] Ensure DocumentationBuilder never has a null preferred MarkupKind #316
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MikhailArkhipov
approved these changes
Oct 27, 2018
jakebailey
pushed a commit
to jakebailey/python-language-server
that referenced
this pull request
Nov 1, 2019
[WIP] Ensure DocumentationBuilder never has a null preferred MarkupKind
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #305.
I opted to move this up into DocumentationBuilder. Hover seems to avoid this problem as it's able to use the helper method
GetMarkupContent, which ensures that the kind is set properly.Completion documentation generation lives in
CompletionAnalysis, and seems to be the only user ofpreferredFormat. Before merging this PR, I'm going to investigate and see how much trouble it'd be to rework doc generation into using the capability-sent list of supported MarkupKinds, so I've marked this as [WIP] for now.