You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/2-review-github-copilot-explain-document-features.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Review GitHub Copilot's "explain" and "document" features
4
4
metadata:
5
5
title: Review GitHub Copilot's "explain" and "document" features
6
6
description: "Review GitHub Copilot's explain and document features"
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/3-examine-github-copilot-prompts-keywords.yml
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/4-analyze-explain-code-using-github-copilot.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Analyze and explain code using GitHub Copilot
4
4
metadata:
5
5
title: Analyze and explain code using GitHub Copilot
6
6
description: "Analyze and explain code using GitHub Copilot"
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/5-generate-project-documentation-using-github-copilot.yml
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/6-generate-inline-code-documentation-using-github-copilot.yml
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/7-exercise-analyze-document-code-github-copilot.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Exercise - Analyze and document code using GitHub Copilot
4
4
metadata:
5
5
title: Exercise - Analyze and document code using GitHub Copilot
6
6
description: "Exercise - Analyze and document code using GitHub Copilot."
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/2-review-github-copilot-explain-document-features.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ GitHub Copilot makes it easier for developers to work with complex or unfamiliar
4
4
5
5
The following GitHub Copilot features can be used to analyze and explain code:
6
6
7
-
- Chat view in Ask mode: Analyze your entire workspace and ask questions about coding topics, technology concepts, and general programming practices.
7
+
-Ask mode: Use the Chat view in ask mode to analyze your entire workspace and ask questions about coding topics, technology concepts, and general programming practices.
8
8
9
9
- Inline Chat: Start an inline chat session directly from the editor to ask about specific code sections.
10
10
@@ -16,11 +16,11 @@ The following GitHub Copilot features can be used to analyze and explain code:
16
16
17
17
The following GitHub Copilot features can be used to generate inline code documentation:
18
18
19
-
-Chat view in Ask mode: Use the Ask mode to suggest inline code documentation for a code file, class, or method. Review the suggested inline documentation in the Chat view. Request updates as needed in the chat conversation. Once you're satisfied with the proposed documentation, you can insert the suggested documentation into the corresponding code file.
19
+
- Ask mode: Use the ask mode to suggest inline code documentation for a code file, class, or method. Review the suggested inline documentation in the Chat view. Request updates as needed in the chat conversation. Once you're satisfied with the proposed documentation, you can insert the suggested documentation into the corresponding code file.
20
20
21
-
-Chat view in Edit mode: Use the Edit mode to suggest inline code documentation for a code file, class, or method. Review the suggested documentation in the editor, navigating between suggested updates. Accept or reject individual suggestions, or modify suggestions as needed.
21
+
- Edit mode: Use the edit mode to suggest inline code documentation for a code file, class, or method. Review the suggested documentation in the editor, navigating between suggested updates. Accept or reject individual suggestions, or modify suggestions as needed.
22
22
23
-
-Chat view in Agent mode: Use the Agent mode to autonomously generate inline code documentation for specified code projects, files, classes, or methods. Have the agent perform additional tasks during or after the documentation process. Accept or reject the updates when the agent has completed the assigned tasks.
23
+
- Agent mode: Use the agent mode to autonomously generate inline code documentation for specified code projects, files, classes, or methods. Have the agent perform additional tasks during or after the documentation process. Accept or reject the updates when the agent has completed the assigned tasks.
24
24
25
25
- Inline chat - Use an inline chat session to work directly in the code editor. The inline chat is useful when you want to document specific code (classes, methods, or code blocks) without leaving the editor. You can provide specific instructions in the prompt or use the `/doc` slash command without additional information if you want. Updates are displayed in the code editor and can be accepted or rejected. You can also choose the option to rerun the prompt with or without updates.
26
26
@@ -30,14 +30,14 @@ The following GitHub Copilot features can be used to generate inline code docume
30
30
31
31
The following GitHub Copilot features can be used to generate project documentation:
32
32
33
-
- Chat view in Ask mode: Use the Ask mode to analyze the codebase and gain an understanding of the code projects, files, and classes. Use Ask mode to preview suggested project documentation. Review suggestions and request updates or additional details as needed. Insert the suggested documentation into a project documentation file (README.md).
33
+
- Chat view in ask mode: Use the ask mode to analyze the codebase and gain an understanding of the code projects, files, and classes. Use ask mode to preview suggested project documentation. Review suggestions and request updates or additional details as needed. Insert the suggested documentation into a project documentation file (README.md).
34
34
35
35
- Chat view in Edit mode: Generate a project documentation file (README.md).
36
36
37
-
- Chat view in Agent mode: Generate a collection of project documentation files: create/update the README.md, create/update the UsageExamples.md, and create/update the ChangeLog.md. Include links between the documentation files, cross-reference classes and methods, and ensure consistency across docs.
37
+
- Chat view in agent mode: Generate a collection of project documentation files: create/update the README.md, create/update the UsageExamples.md, and create/update the ChangeLog.md. Include links between the documentation files, cross-reference classes and methods, and ensure consistency across docs.
38
38
39
39
> [!IMPORTANT]
40
-
> When you use the Chat view in Agent mode, GitHub Copilot may make multiple premium requests to complete a single task. This includes both user-initiated prompts and follow-up actions Copilot takes on your behalf. The total premium requests used will depend on the complexity of the task, the number of steps involved, and the model selected.
40
+
> When you use the Chat view in agent mode, GitHub Copilot may make multiple premium requests to complete a single task. This includes both user-initiated prompts and follow-up actions Copilot takes on your behalf. The total premium requests used will depend on the complexity of the task, the number of steps involved, and the model selected.
0 commit comments