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

Test the updated refactoring.documentation proposal #91318

Closed
2 tasks done
mjbvz opened this issue Feb 24, 2020 · 0 comments
Closed
2 tasks done

Test the updated refactoring.documentation proposal #91318

mjbvz opened this issue Feb 24, 2020 · 0 comments

Comments

@mjbvz
Copy link
Collaborator

mjbvz commented Feb 24, 2020

Test for #86788

Complexity: 4

Background
The proposed CodeActionProviderMetadata.documentation lets extensions contribute documentation entries for specific a CodeActionKind

The documentation entries are rendered at the bottom of the completion list

Testing
Using the code action sample extension, try contributing some documentation. Specifically, try creating a documentation contribution for CodeActionKind.Refactor:

  • Can you get the contribution to show up as expected?

  • Make sure this entry only shows up when the code action provider is registered (and that unregistering the provider removes the documentation entry)

  • For your test Refactor documentation, make sure that the entry only shows up when you would expect:

    • It should only show in the lightbulb menu if your provider returns at least one Refactoring code action,
    • It should always show up in the refactor menu.
  • Try creating a documentation for some other cases, such a QuickFix to make sure these also follow the same rules.

  • Try adding a more specific documentation entry for refactoring, such as RefactorExtract`.

    • Confirm that in this case, the most specific documentation entry should be shown
@mjbvz mjbvz added this to the February 2020 milestone Feb 24, 2020
@roblourens roblourens removed their assignment Feb 26, 2020
@eamodio eamodio removed their assignment Feb 26, 2020
@eamodio eamodio closed this as completed Feb 26, 2020
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants