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.

Sign up for GitHub

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

Jump to bottom

add vscode mentions #3898

Merged
merged 9 commits into from
Jul 8, 2024
Merged

add vscode mentions #3898

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
121f899
add vscode mentions
noklam May 28, 2024
a24c9bc
Merge branch 'main' into noklam/vscode-mention
noklam Jun 10, 2024
559842f
add gif
noklam Jun 10, 2024
da6770f
VSCode -> VS Code
noklam Jun 12, 2024
373aeb7
fix docs based on review
noklam Jun 12, 2024
2d0239e
Merge branch 'main' into noklam/vscode-mention
noklam Jun 12, 2024
82bf144
Merge branch 'main' into noklam/vscode-mention
noklam Jun 24, 2024
555e66c
Merge branch 'main' into noklam/vscode-mention
noklam Jul 8, 2024
13964a5
fix link
noklam Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/source/development/set_up_vscode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@

![](../meta/images/vscode_setup_interpreter.png)

## Kedro VSCode Extension

Check warning on line 13 in docs/source/development/set_up_vscode.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/development/set_up_vscode.md#L13 

[Kedro.headings] 'Kedro VSCode Extension' should use sentence-style capitalization.
Raw output 
{"message": "[Kedro.headings] 'Kedro VSCode Extension' should use sentence-style capitalization.", "location": {"path": "docs/source/development/set_up_vscode.md", "range": {"start": {"line": 13, "column": 4}}}, "severity": "WARNING"}
noklam marked this conversation as resolved.
Show resolved Hide resolved
[Kedro VSCode extension](https://marketplace.visualstudio.com/items?itemName=kedro.Kedro) support 0.19+ versions of Kedro project. It supports features like go-to definition, find references and hovers etc.

Check warning on line 14 in docs/source/development/set_up_vscode.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/development/set_up_vscode.md#L14 

[Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
Raw output 
{"message": "[Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.", "location": {"path": "docs/source/development/set_up_vscode.md", "range": {"start": {"line": 14, "column": 203}}}, "severity": "WARNING"}
astrojuanlu marked this conversation as resolved.
Show resolved Hide resolved
astrojuanlu marked this conversation as resolved.
Show resolved Hide resolved

![Kedro VSCode gif](https://github.com/kedro-org/vscode-kedro/blob/main/assets/lsp-go-to-definition.gif?raw=true)

Check warning on line 16 in docs/source/development/set_up_vscode.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/development/set_up_vscode.md#L16 

[Kedro.Spellings] Did you really mean 'gif'?
Raw output 
{"message": "[Kedro.Spellings] Did you really mean 'gif'?", "location": {"path": "docs/source/development/set_up_vscode.md", "range": {"start": {"line": 16, "column": 16}}}, "severity": "WARNING"}
## Advanced: For those using `venv` / `virtualenv`

We're going to show you how to get your virtual environments to show up in your Python interpreter in VS Code. You do this by opening [`settings.json`](https://code.visualstudio.com/docs/getstarted/settings#_settings-file-locations) and adding the following:
Expand Down
4 changes: 4 additions & 0 deletions docs/source/get_started/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,11 @@
```bash
conda deactivate
```
### Optional: Setup Kedro with IDE

Check warning on line 83 in docs/source/get_started/install.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/get_started/install.md#L83 

[Kedro.headings] 'Optional: Setup Kedro with IDE' should use sentence-style capitalization.
Raw output 
{"message": "[Kedro.headings] 'Optional: Setup Kedro with IDE' should use sentence-style capitalization.", "location": {"path": "docs/source/get_started/install.md", "range": {"start": {"line": 83, "column": 5}}}, "severity": "WARNING"}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Optional: Setup Kedro with IDE
### Optional: Add Kedro support to your IDE

? (Unusure about this one as well, requesting @stichbury's opinion)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Integrate ESLint in VSCode with the official extension

Integrate Kedro in VS Code with the official extension? @astrojuanlu

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1!

Working in IDEs can be a great productivity boost.
noklam marked this conversation as resolved.
Show resolved Hide resolved

For VS Code Users: Checkout [Set up Visual Studio Code](../development/set_up_vscode.md) and [Kedro VSCode Extension](../development/set_up_vscode.md#kedro-vscode-extension)
For PyCharm Users: Checkout [Set up PyCharm](../development/set_up_pycharm.md)

## How to install Kedro using `pip`

Expand Down