Add documentation for VSCode whole-line autocomplete #351

ayim · 2022-04-15T01:24:11Z

Summary of changes
Added documentation for VSCode whole-line autocompletions.
Most of the content is from the Readme.MD for the extension itself.

Review Instructions
I recommend reviewing this PR by using github.dev.
Press the "." key, then use the markdown preview (top right bar).

vivlimmsft · 2022-04-15T18:37:59Z

docs/intellicode-visual-studio-code.md

+The extension is supported by Visual Studio Code October 2018 Release 1.29 or later.
+
+AI-assisted IntelliSense for Java requires Java 8 Update 151 or higher. 
+## Whole-line autocomplete preview


The way the page weaves between talking about the WLC extension and the main extension is confusing. The WLC extension also has a higher minimum version and narrower language support, which should be mentioned.

+1 to Viv's comment here - we should clearly state the constraints/requirements for "whole line completion preview".
We also need to ensure that if we're adopting "Whole-line autocomplete" we do so everywhere it is mentioned (docs AND product)

I'm wondering whether one way to do this is to open the section with this text to make the link between the preview-ness and the extension clear.

"IntelliCode also has a preview release that allows you to try out whole line completions for Python and JavaScript/TypeScript files.

This preview is provided via a separate extension, which you can acquire here [url]. It requires version X.Y.Z of Visual Studio Code or higher"

An even clearer way might be to move the whole section to its own file and link to it from here, making the separation cleaner. Once the preview period is over we could fold back here.

vivlimmsft · 2022-04-15T18:38:24Z

docs/intellicode-visual-studio-code.md

+
+### Installation
+
+We recommend using the [IntelliCode Completions extension for VS Code]() together with the [main IntelliCode extension for VS Code]().


These links don't go anywhere yet.

vivlimmsft · 2022-04-15T18:39:17Z

docs/intellicode-visual-studio-code.md

+
+Completions will appear after your cursor as you type, with a faded color. At any time, you can accept the suggestion by pressing the tab key. Additionally, you can dismiss any shown suggestion by pressing the ESC key.
+
+![IntelliCode Completions interpreting IntelliSense completion list selection in Visual Studio Code](../images/intellisenseSelection.gif)


i think it's worth mentioning that the completion list selection is used to inform which prediction you get

and possibly that it takes two tab presses

+1 to Viv's comments. I'd also say, in the sentence about accepting/rejecting the suggestion, to stay consistent with our description elsewhere:

"At any time you can accept the suggestion by pressing the tab key (you will need to press it twice if the IntelliSense list is up). If you don't want to accept the suggestion, you can just keep on typing or press ESC"

DavidObando

It reads well, my only comment is on updating the supported version of VSCode.

docs/intellicode-visual-studio-code.md

vivlimmsft · 2022-04-15T18:41:56Z

Oh, I think it would also be good to mention snippet insertion's tab interaction

markw-t

Left a few comments; I think a little restructure should clarify the two feature sets (WLC preview vs the rest)

markw-t · 2022-04-15T22:01:05Z

docs/intellicode-visual-studio-code.md

+The extension is supported by Visual Studio Code October 2018 Release 1.29 or later.
+
+AI-assisted IntelliSense for Java requires Java 8 Update 151 or higher. 
+## Whole-line autocomplete preview


+1 to Viv's comment here - we should clearly state the constraints/requirements for "whole line completion preview".
We also need to ensure that if we're adopting "Whole-line autocomplete" we do so everywhere it is mentioned (docs AND product)

markw-t · 2022-04-15T22:30:41Z

docs/intellicode-visual-studio-code.md

+The extension is supported by Visual Studio Code October 2018 Release 1.29 or later.
+
+AI-assisted IntelliSense for Java requires Java 8 Update 151 or higher. 
+## Whole-line autocomplete preview


I'm wondering whether one way to do this is to open the section with this text to make the link between the preview-ness and the extension clear.

"IntelliCode also has a preview release that allows you to try out whole line completions for Python and JavaScript/TypeScript files.

This preview is provided via a separate extension, which you can acquire here [url]. It requires version X.Y.Z of Visual Studio Code or higher"

An even clearer way might be to move the whole section to its own file and link to it from here, making the separation cleaner. Once the preview period is over we could fold back here.

markw-t · 2022-04-15T22:33:04Z

docs/intellicode-visual-studio-code.md

+
+Completions will appear after your cursor as you type, with a faded color. At any time, you can accept the suggestion by pressing the tab key. Additionally, you can dismiss any shown suggestion by pressing the ESC key.
+
+![IntelliCode Completions interpreting IntelliSense completion list selection in Visual Studio Code](../images/intellisenseSelection.gif)


+1 to Viv's comments. I'd also say, in the sentence about accepting/rejecting the suggestion, to stay consistent with our description elsewhere:

"At any time you can accept the suggestion by pressing the tab key (you will need to press it twice if the IntelliSense list is up). If you don't want to accept the suggestion, you can just keep on typing or press ESC"

docs/intellicode-visual-studio-code.md

juihanamshet1 · 2022-04-18T17:15:34Z

docs/intellicode-visual-studio-code.md

+The extension is supported by Visual Studio Code October 2018 Release 1.29 or later.
+
+AI-assisted IntelliSense for Java requires Java 8 Update 151 or higher. 
+## Whole-line autocomplete preview


I believe we decided on the name to be whole line completions

That's what we decided at VS22 launch time with marketing.
Since then, there's been two clarifications

Our copywriter says that whole must always have a dash with line (Brick George has the full details on why this grammar is important)

Autocomplete is more immediately relateable

docs/intellicode-visual-studio-code.md

ayim · 2022-04-19T20:59:17Z

Summary of changes

Added info about snippet completion
Separated content about whole-line autocompletion to a separate page

juihanamshet1 · 2022-04-19T20:59:08Z

docs/intellicode-visual-studio-code-completions.md

+
+Completions will appear after your cursor as you type, with a faded color. When the IntelliSense list is open, its selection is used to inform the whole-line autocompletion.
+
+At any time you can accept the suggestion by pressing the tab key (you will need to press it twice if the IntelliSense list is visible). If you don't want to accept the suggestion, you can just keep on typing or press ESC


change "tab" to "TAB" to keep it consistent with "ESC"

docs/intellicode-visual-studio-code-completions.md

juihanamshet1 · 2022-04-19T21:01:51Z

docs/intellicode-visual-studio-code-completions.md

+
+## Provide feedback
+
+If you encounter a problem, you can browse [existing issues](https://github.com/MicrosoftDocs/intellicode/issues) and upvote them using a 👍 "thumbs up" reaction. If you don't see your particular problem, we'd love to hear from you. Include any **Output** window log entries from Visual Studio IntelliCode, Python, Java, JavaScript, or TypeScript with the bug.


might be helpful to include a screenshot of how to do this

docs/intellicode-visual-studio-code.md

docs/overview.md

ayim added 3 commits April 14, 2022 18:16

Added content for whole-line autocompletions

99e0c84

Restructured content on page

f72d26d

Added installation instructions

4c896c4

ayim requested review from DavidObando, markw-t and vivlimmsft April 15, 2022 01:24

ayim changed the title ~~Aayim vscwlc~~ Add documentation for VSCode whole-line autocomplete Apr 15, 2022

vivlimmsft requested changes Apr 15, 2022

View reviewed changes

DavidObando approved these changes Apr 15, 2022

View reviewed changes

docs/intellicode-visual-studio-code.md Outdated Show resolved Hide resolved

markw-t suggested changes Apr 15, 2022

View reviewed changes

juihanamshet1 reviewed Apr 18, 2022

View reviewed changes

docs/intellicode-visual-studio-code.md Outdated Show resolved Hide resolved

juihanamshet1 reviewed Apr 18, 2022

View reviewed changes

ayim added 6 commits April 19, 2022 13:40

Added a page to encapsulate IntelliCode Completion

8d1fa78

Updated version info based on David's feedback

a24d1e2

Added info about vsc-wlc to the overview page

ef6f5f1

Removed vsc-wlc content from main VSC Intellicode page

3327107

Reordered 'how to use' content

cd577fa

Added content RE: snippet completion

31dfdbf

Improved punctuation and clarity

0e16181

juihanamshet1 approved these changes Apr 19, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for VSCode whole-line autocomplete #351

Add documentation for VSCode whole-line autocomplete #351

ayim commented Apr 15, 2022 •

edited

Loading

vivlimmsft Apr 15, 2022

markw-t Apr 15, 2022

markw-t Apr 15, 2022

vivlimmsft Apr 15, 2022

vivlimmsft Apr 15, 2022

vivlimmsft Apr 15, 2022

markw-t Apr 15, 2022

DavidObando left a comment

vivlimmsft commented Apr 15, 2022

markw-t left a comment

markw-t Apr 15, 2022

markw-t Apr 15, 2022

markw-t Apr 15, 2022

juihanamshet1 Apr 18, 2022

ayim Apr 18, 2022

ayim commented Apr 19, 2022

juihanamshet1 Apr 19, 2022

juihanamshet1 Apr 19, 2022


		### Installation

		We recommend using the [IntelliCode Completions extension for VS Code]() together with the [main IntelliCode extension for VS Code]().


		Completions will appear after your cursor as you type, with a faded color. At any time, you can accept the suggestion by pressing the tab key. Additionally, you can dismiss any shown suggestion by pressing the ESC key.

		![IntelliCode Completions interpreting IntelliSense completion list selection in Visual Studio Code](../images/intellisenseSelection.gif)


		Completions will appear after your cursor as you type, with a faded color. When the IntelliSense list is open, its selection is used to inform the whole-line autocompletion.

		At any time you can accept the suggestion by pressing the tab key (you will need to press it twice if the IntelliSense list is visible). If you don't want to accept the suggestion, you can just keep on typing or press ESC


		## Provide feedback

		If you encounter a problem, you can browse [existing issues](https://github.com/MicrosoftDocs/intellicode/issues) and upvote them using a 👍 "thumbs up" reaction. If you don't see your particular problem, we'd love to hear from you. Include any Output window log entries from Visual Studio IntelliCode, Python, Java, JavaScript, or TypeScript with the bug.

Add documentation for VSCode whole-line autocomplete #351

Are you sure you want to change the base?

Add documentation for VSCode whole-line autocomplete #351

Conversation

ayim commented Apr 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DavidObando left a comment

Choose a reason for hiding this comment

vivlimmsft commented Apr 15, 2022

markw-t left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayim commented Apr 19, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayim commented Apr 15, 2022 •

edited

Loading