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

Add document page to assists #6042

Open
1 task
FMorschel opened this issue Aug 14, 2024 · 2 comments
Open
1 task

Add document page to assists #6042

FMorschel opened this issue Aug 14, 2024 · 2 comments
Labels
co.request Community ask for documentation d.enhancement Improves docs with specific ask e3-weeks Complete in < 4 weeks of normal, not dedicated, work from.user Issue raised by user p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. t.diagnostics Relates to diagnostics, analysis, or linting of code

Comments

@FMorschel
Copy link

What information needs to be added?

A list of all the asists available and where on the code do they trigger. What change will that make, which could be copied from the current tests.

I believe that would help people be more familiar with them.

Where should this new content appear?

Under the docs session.

I would like to fix this problem.

  • I will try and fix this problem on dart.dev.
@FMorschel FMorschel added co.request Community ask for documentation from.user Issue raised by user labels Aug 14, 2024
@parlough parlough added p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e3-weeks Complete in < 4 weeks of normal, not dedicated, work t.diagnostics Relates to diagnostics, analysis, or linting of code d.enhancement Improves docs with specific ask labels Aug 30, 2024
@bwilkerson
Copy link
Member

If we do this we should also include documentation of the refactorings. (That might be implied by the original request, but we make a distinction in the implementation between assists and refactorings, so I wanted it to be stated explicitly.) Documenting the fixes is less clear given that they're generally easy to find (though the change they make might not be obvious in all cases).

@DanTup
Copy link
Contributor

DanTup commented Sep 25, 2024

Slightly related - VS Code allows us to provide some text/a command that can be shown at the bottom of the refactor list:

microsoft/vscode#86788

image

It's not per-action documentation, we just get to say "If the list is for CodeAction.Refactor, include this documentation action" (that calls a command). If the refactorings were documented on the website, we could add this and link to them so that (VS Code) users can easily find them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
co.request Community ask for documentation d.enhancement Improves docs with specific ask e3-weeks Complete in < 4 weeks of normal, not dedicated, work from.user Issue raised by user p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. t.diagnostics Relates to diagnostics, analysis, or linting of code
Projects
None yet
Development

No branches or pull requests

4 participants