Skip to content

Commit 4acaaf3

Browse files
committed
small english improvements
1 parent 8f94314 commit 4acaaf3

2 files changed

Lines changed: 17 additions & 18 deletions

File tree

docs/quickstart/vscode.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Visual Studio Code Extension
22

3-
> The extension is currently in **preview** and as such is subject to change. You may also encounter bugs and api incompatibilities with the SQLMesh version you are running. We encourage you to try it and raise any issues [here](https://github.com/tobikodata/sqlmesh/issues).
3+
> The extension is currently in **preview** and as such is subject to change. You may also encounter bugs and API incompatibilities with the SQLMesh version you are running. We encourage you to try it and raise any issues [here](https://github.com/tobikodata/sqlmesh/issues).
44
5-
In this quickstart guide, you'll set up the SQLMesh extension in Visual Studio Code, we'll show you the capabilities of the extension and how to troubleshoot common issues.
5+
In this quickstart guide, you'll set up the SQLMesh extension in Visual Studio Code. We'll show you the capabilities of the extension and how to troubleshoot common issues.
66

77
## Installation
88

99
Installation is done through the VSCode extension marketplace, search for `SQLMesh` and install the extension from the [marketplace](https://marketplace.visualstudio.com/items?itemName=tobikodata.sqlmesh). For a more in depth guide on how to install extensions, see the [VSCode documentation](https://code.visualstudio.com/docs/configure/extensions/extension-marketplace#_install-an-extension).
1010

1111
### Recommended setup
1212

13-
While installing the extension is simple, setting up a python environment correctly is a bit more involved. We do recommend using a dedicated *python virtual environment* to install SQLMesh. For a complete guide visit the [python documentation](https://docs.python.org/3/library/venv.html) but the following steps will create the virtual environment, activate it and install SQLMesh for both a SQLMesh core setup and a Tobiko Cloud setup.
13+
While installing the extension is simple, setting up a Python environment correctly is a bit more involved. We do recommend using a dedicated *Python virtual environment* to install SQLMesh. For a complete guide, visit the [Python documentation](https://docs.python.org/3/library/venv.html), but the following steps will create the virtual environment, activate it, and install SQLMesh for both a SQLMesh core setup and a Tobiko Cloud setup.
1414

1515
#### SQLMesh Core
1616

@@ -22,37 +22,37 @@ source .venv/bin/activate
2222
pip install 'sqlmesh[lsp]'
2323
```
2424

25-
Once you have the virtual environment, you can make sure that Visual Studio Code is using the correct python interpreter by going to the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and running `Python: Select Interpreter`. Select the python executable in the virtual environment.
25+
Once you have the virtual environment, you can ensure that Visual Studio Code is using the correct Python interpreter by going to the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and running `Python: Select Interpreter`. Select the Python executable in the virtual environment.
2626

2727
![Select interpreter](./vscode/select_interpreter.png)
2828

29-
Once that's done, you can validate that the extension is correctly using the virtual environment by checking the `sqlmesh` output channel in the [output panel](https://code.visualstudio.com/docs/getstarted/userinterface#_output-panel) which details the python path and the details of your SQLMesh installation and looks as follows:
29+
Once that's done, you can validate that the extension is correctly using the virtual environment by checking the `sqlmesh` output channel in the [output panel](https://code.visualstudio.com/docs/getstarted/userinterface#_output-panel), which details the Python path and the details of your SQLMesh installation and looks as follows:
3030

3131
![Output panel](./vscode/interpreter_details.png)
3232

3333
#### Tobiko Cloud
3434

35-
For Tobiko Cloud, the tcloud utility is used to install SQLMesh, so you'll need to set up a python environment, activate it and install SQLMesh using the tcloud utility as follows.
35+
For Tobiko Cloud, the `tcloud` utility is used to install SQLMesh, so you'll need to set up a Python environment, activate it, and install SQLMesh using the tcloud utility as follows.
3636

3737
```bash
3838
python -m venv .venv
3939
source .venv/bin/activate
4040
pip install tcloud
4141
```
4242

43-
Once you have the virtual environment, you can make sure that Visual Studio Code is using the correct python interpreter by going to the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and running `Python: Select Interpreter`. Select the python executable in the virtual environment.
43+
Once you have the virtual environment, you can ensure that Visual Studio Code is using the correct Python interpreter by going to the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and running `Python: Select Interpreter`. Select the Python executable in the virtual environment.
4444

4545
![Select interpreter](./vscode/select_interpreter.png)
4646

47-
You can use the `tcloud` commands in your terminal to do the operations as usual, or the extension exposes the same commands through the command palette under the following commands:
47+
You can use the `tcloud` commands in your terminal to perform operations as usual, or the extension exposes the same commands through the command palette under the following commands:
4848
- `Sign in to Tobiko Cloud`
4949
- `Sign out of Tobiko Cloud`
5050

5151
## Features
5252

5353
### Lineage
5454

55-
The extension adds a lineage view to the SQLMesh models. To view the lineage of a model, use the `Lineage` tab in the panel as shown below:
55+
The extension adds a lineage view to SQLMesh models. To view the lineage of a model, use the `Lineage` tab in the panel as shown below:
5656

5757
![Lineage view](./vscode/lineage.png)
5858

@@ -66,27 +66,27 @@ The extension exposes the following commands through the command palette:
6666

6767
### LSP Features
6868

69-
The SQLMesh LSP adds a number of features to the editor:
69+
The SQLMesh LSP adds several features to the editor:
7070

7171
**Completion**
7272

73-
When writing SQL models, keywords or model names, you should see a completion suggestion.
73+
When writing SQL models, keywords, or model names, you should see completion suggestions.
7474

7575
![Completion](./vscode/autocomplete.png)
7676

7777
**Go to definition and hover information**
7878

79-
The SQLMesh LSP adds a definition provider for SQLMesh models. When you hover over a model name, you should see a tooltip with the model description and on click you will be taken to the model definition.
79+
The SQLMesh LSP adds a definition provider for SQLMesh models. When you hover over a model name, you should see a tooltip with the model description, and when you click, you will be taken to the model definition.
8080

8181
**Diagnostics**
8282

83-
The SQLMesh LSP adds a diagnostic provider for your SQLMesh project. If you have the SQLMesh linter enabled, issues will be reported in your editor. This works for both SQLMesh built in rules and custom rules.
83+
The SQLMesh LSP adds a diagnostic provider for your SQLMesh project. If you have the SQLMesh linter enabled, issues will be reported in your editor. This works for both SQLMesh built-in rules and custom rules.
8484

8585
![Diagnostics](./vscode/diagnostics.png)
8686

8787
**Formatting**
8888

89-
The SQLMesh LSP also adds a formatting provider for SQLMesh models. When you write SQL models, you should see the model formatted correctly.
89+
The SQLMesh LSP also adds a formatting provider for SQLMesh models. When you write SQL models, you can use formatter to foramt models consistently.
9090

9191
## Troubleshooting
9292

@@ -98,13 +98,12 @@ When installing SQLMesh, some dependencies that are required by the extension ar
9898
pip install 'sqlmesh[lsp]'
9999
```
100100

101-
If you are in a cloud environment, you can make sure the extension requirements are correctly installed by adding `lsp` to the list of extras required in the `tcloud.yaml` file.
101+
If you are in a cloud environment, you can ensure the extension requirements are correctly installed by adding `lsp` to the list of extras required in the `tcloud.yaml` file.
102102

103103
### Python environment woes
104104

105-
The most common issue is that the extension is not using the correct python interpreter. We recommend following the [recommended setup](#recommended-setup) to ensure that the extension is using the correct python interpreter. If you have checked the `sqlmesh` output channel and the extension is still not using the correct python interpreter, please raise an issue [here](https://github.com/tobikodata/sqlmesh/issues).
105+
The most common issue is that the extension is not using the correct Python interpreter. We recommend following the [recommended setup](#recommended-setup) to ensure that the extension is using the correct Python interpreter. If you have checked the `sqlmesh` output channel and the extension is still not using the correct Python interpreter, please raise an issue [here](https://github.com/tobikodata/sqlmesh/issues).
106106

107107
### SQLMesh compatibility
108108

109109
While the extension is in preview and the APIs to the underlying SQLMesh version are not stable, we do not guarantee compatibility between the extension and the SQLMesh version you are using. If you encounter an issue, please raise an issue [here](https://github.com/tobikodata/sqlmesh/issues).
110-

examples/sushi/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
default_gateway="duckdb",
4242
model_defaults=model_defaults,
4343
linter=LinterConfig(
44-
enabled=True,
44+
enabled=False,
4545
rules=[
4646
"ambiguousorinvalidcolumn",
4747
"invalidselectstarexpansion",

0 commit comments

Comments
 (0)