summaryrefslogtreecommitdiff
path: root/extension
diff options
context:
space:
mode:
authorNate Sesti <sestinj@gmail.com>2023-06-02 19:45:17 -0400
committerNate Sesti <sestinj@gmail.com>2023-06-02 19:45:17 -0400
commitbd7d3b8e524324a78667ca3eee01f9d7ae1181f3 (patch)
treef481a49b63d89ef5d667dce0ec9a4b791786834e /extension
parent57c3b77a5fe9ca73fb54d2c518470ef834aa9d72 (diff)
parent8970af9e695fe8196f4f3b61dd16271ae733f630 (diff)
downloadsncontinue-bd7d3b8e524324a78667ca3eee01f9d7ae1181f3.tar.gz
sncontinue-bd7d3b8e524324a78667ca3eee01f9d7ae1181f3.tar.bz2
sncontinue-bd7d3b8e524324a78667ca3eee01f9d7ae1181f3.zip
Merge branch 'docs'
Diffstat (limited to 'extension')
-rw-r--r--extension/README.md12
-rw-r--r--extension/react-app/src/components/CodeMultiselect.tsx2
-rw-r--r--extension/react-app/src/components/VSCodeFileLink.tsx4
-rw-r--r--extension/react-app/src/tabs/chat/MessageDiv.tsx2
-rw-r--r--extension/scripts/README.md2
-rw-r--r--extension/src/README.md14
6 files changed, 23 insertions, 13 deletions
diff --git a/extension/README.md b/extension/README.md
index 55cf25d1..51e95822 100644
--- a/extension/README.md
+++ b/extension/README.md
@@ -14,4 +14,14 @@ Ask natural language questions of your codebase, like "Where is the entry point
Request an edit to the currently open file, for example: "Add CORS headers to this FastAPI server".
-### Generate Unit Tests
+### Generate a Fix
+
+Once Continue has code snippets to work with, it can generate a fix. Just click to accept or reject, or make the tweak you need.
+
+### Stacktrace Parsing
+
+Any stacktrace that appears in your VS Code terminal will be caught by us so we can immediately begin the debugging process. For small bugs that you might have quickly solved, we'll just speed up the process to be nearly instantaneous.
+
+### Generate Unit Tests and Docstrings
+
+Use `cmd+shift+i` to generate a unit test for the function surrounding your cursor position, and `cmd+shift+l` to generate a docstring.
diff --git a/extension/react-app/src/components/CodeMultiselect.tsx b/extension/react-app/src/components/CodeMultiselect.tsx
index 626ae42f..c0ab9400 100644
--- a/extension/react-app/src/components/CodeMultiselect.tsx
+++ b/extension/react-app/src/components/CodeMultiselect.tsx
@@ -135,7 +135,7 @@ function formatFileRange(
)} (lines ${rangeInFile.range.start.line + 1}-${
rangeInFile.range.end.line + 1
})`;
- // +1 because VSCode Ranges are 0-indexed
+ // +1 because VS Code Ranges are 0-indexed
}
//#endregion
diff --git a/extension/react-app/src/components/VSCodeFileLink.tsx b/extension/react-app/src/components/VSCodeFileLink.tsx
index 6219654d..12ce5af8 100644
--- a/extension/react-app/src/components/VSCodeFileLink.tsx
+++ b/extension/react-app/src/components/VSCodeFileLink.tsx
@@ -1,7 +1,7 @@
import React from "react";
import { postVscMessage } from "../vscode";
-function VSCodeFileLink(props: { path: string; text?: string }) {
+function VS CodeFileLink(props: { path: string; text?: string }) {
return (
<a
href={`file://${props.path}`}
@@ -14,4 +14,4 @@ function VSCodeFileLink(props: { path: string; text?: string }) {
);
}
-export default VSCodeFileLink;
+export default VS CodeFileLink;
diff --git a/extension/react-app/src/tabs/chat/MessageDiv.tsx b/extension/react-app/src/tabs/chat/MessageDiv.tsx
index ad81f5e9..9bdd8638 100644
--- a/extension/react-app/src/tabs/chat/MessageDiv.tsx
+++ b/extension/react-app/src/tabs/chat/MessageDiv.tsx
@@ -6,7 +6,7 @@ import {
defaultBorderRadius,
secondaryDark,
} from "../../components";
-import VSCodeFileLink from "../../components/VSCodeFileLink";
+import VS CodeFileLink from "../../components/VS CodeFileLink";
import ReactMarkdown from "react-markdown";
import "../../highlight/dark.min.css";
import hljs from "highlight.js";
diff --git a/extension/scripts/README.md b/extension/scripts/README.md
index 0f851cb4..da1ad493 100644
--- a/extension/scripts/README.md
+++ b/extension/scripts/README.md
@@ -1,5 +1,5 @@
# Scripts
-Whenever we need python to run on the client side, we include a script file at the top level of this folder. All other files that are not to be run directly as a script (utility files) should be in a subfolder of `scripts`. You can call one of these scripts from the VSCode extension using the `runPythonScript` function in `bridge.ts`.
+Whenever we need python to run on the client side, we include a script file at the top level of this folder. All other files that are not to be run directly as a script (utility files) should be in a subfolder of `scripts`. You can call one of these scripts from the VS Code extension using the `runPythonScript` function in `bridge.ts`.
When the extension is activated (`activate` function in `src/extension.ts`), we call `setupPythonEnv`, which makes the virtual environment and downloads all the necessary requirements as given in `requirements.txt`. With this in mind, be sure to run `pip freeze > requirements.txt` whenever you add a new requirement.
diff --git a/extension/src/README.md b/extension/src/README.md
index bb10f5c8..76b96ea0 100644
--- a/extension/src/README.md
+++ b/extension/src/README.md
@@ -22,23 +22,23 @@
10. Then run `npm run compile`
-7. Open `src/activate.ts` file (or any TypeScript file)
+11. Open `src/activate.ts` file (or any TypeScript file)
-7. Press `F5` on your keyboard to start `Run and Debug` mode
+12. Press `F5` on your keyboard to start `Run and Debug` mode
-8. `cmd+shift+p` to look at developer console and select Continue commands
+13. `cmd+shift+p` to look at developer console and select Continue commands
-9. Every time you make changes to the code, you need to run `npm run compile`
+14. Every time you make changes to the code, you need to run `npm run compile`
-10. If you run into a "command not found" error, try running `npm run rebuild` and then `npm run compile`
+15. If you run into a "command not found" error, try running `npm run rebuild` and then `npm run compile`
## Alternative: Install a packaged version
-You should always have a packaged version installed in VSCode, because when Continue is broken you'll want a stable version to help you debug. There are four key commands in the `package.json`:
+You should always have a packaged version installed in VS Code, because when Continue is broken you'll want a stable version to help you debug. There are four key commands in the `package.json`:
1. `npm run package` will create a .vsix file in the `build/` folder that can then be installed. It is this same file that you can share with others who want to try the extension.
-2. `npm run install-extension` will install the extension to VSCode. You should then see it in your installed extensions in the VSCode sidebar.
+2. `npm run install-extension` will install the extension to VS Code. You should then see it in your installed extensions in the VS Code sidebar.
3. `npm run uninstall` will uninstall the extension. You don't always have to do this thanks to the reinstall command, but can be useful when you want to do so manually.