Skip to content

Commit 86e1bde

Browse files
address review comments
1 parent 62f62ef commit 86e1bde

File tree

6 files changed

+16
-8
lines changed

6 files changed

+16
-8
lines changed

userdocs/userdocs.docc/Articles/Advanced/install-pre-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Installing Pre-Release Builds
22

3-
Live on the bleeding edge by switching to the pre-release version.
3+
Try out the latest updates by switching to the pre-release version.
44

55
The Swift extension provides pre-release builds that can be used to test out unreleased features or get bug fixes before an official release can be published. Pre-release build numbers are always one minor version ahead of the most recent release.
66

userdocs/userdocs.docc/Articles/Features/language-features.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,12 @@
22

33
Language features to help you write Swift code.
44

5-
The Swift extension provides language features such as code completion and jump to definition via [SourceKit-LSP](https://github.com/apple/sourcekit-lsp). To ensure the extension functions correctly, it’s important to first build the project so that SourceKit-LSP has access to all the symbol data. Whenever you add a new dependency to your project, make sure to rebuild it so that SourceKit-LSP can update its information.
5+
> 💡 Tip: Language features are common to all VS Code extensions. See the [VS Code documentation about navigating code](https://code.visualstudio.com/docs/editing/editingevolved) for a more in-depth overview.
6+
7+
The Swift extension provides language features such as code completion and jump to definition via [SourceKit-LSP](https://github.com/apple/sourcekit-lsp).
8+
9+
> ⚠️ Important: With Swift toolchains prior to 6.1 you will need to build your project at least once for SourceKit-LSP to function correcly. Whenever you add a new dependency to your project, make sure to rebuild it so that SourceKit-LSP can update its information.
10+
11+
SourceKit-LSP provides background indexing in Swift toolchain 6.1 which will automatically index your project on startup. All indexing results are cached in the `.build/index-build` folder within your workspace.
12+
13+
SourceKit-LSP can be configured via extension settings. See <doc:settings> for more information.

userdocs/userdocs.docc/Articles/Features/project-view.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Swift Project View
22

3-
View aspects of your Swift project at a glance.
3+
Navigate your Swift project.
44

55
If your workspace contains a package, this extension will add a **Swift Project** view to the Explorer:
66

userdocs/userdocs.docc/Articles/Features/test-explorer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
vscode-swift shows test results in the test explorer.
44

5-
> 💡 Tip: The Test Explorer UI is common to all VS Code extensions. See the [VS Code documentation about testing](https://code.visualstudio.com/docs/debugtest/testing) for a more in-depth overview.
5+
> 💡 Tip: The Testing view is common to all VS Code extensions. See the [VS Code documentation about testing](https://code.visualstudio.com/docs/debugtest/testing) for a more in-depth overview.
66
77
If your package contains tests then they can be viewed, run and debugged in the Test Explorer.
88

userdocs/userdocs.docc/Articles/Reference/commands.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Useful VS Code commands added by the Swift extension.
44

55
> 💡 Tip: Commands can be accessed from the VS Code command palette which is common to all VS Code extensions. See the [VS Code documentation about the command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) for a more in-depth overview.
66
7-
The Swift extension adds the following commands, each prefixed with `"Swift: "` in the UI.
7+
The Swift extension adds the following commands, each prefixed with `"Swift: "` in the command palette.
88

99
#### Configuration
1010

@@ -14,14 +14,14 @@ The Swift extension adds the following commands, each prefixed with `"Swift: "`
1414

1515
The following command is only available on macOS:
1616

17-
- **`Select Target Platform...`** - An experimental command that offers code completion for iOS and tvOS projects.
17+
- **`Select Target Platform...`** - An experimental command available in Swift 6.1 that offers code completion for iOS, tvOS, watchOS, and visionOS projects.
1818

1919
#### Building and Debugging
2020

2121
- **`Run Build`** - Run `swift build` for the package associated with the open file.
2222
- **`Debug Build`** - Run `swift build` with debugging enabled for the package associated with the open file, launching the binary and attaching the debugger.
2323
- **`Attach to Process...`** - Attach the debugger to an already running process for debugging.
24-
- **`Clean Build Folder`** - Clean the build folder for the package associated with the open file, removing all previously built products.
24+
- **`Clean Build Folder`** - Clean the `.build` folder for the package associated with the open file, removing all previously built products.
2525

2626
#### Dependency Management
2727

userdocs/userdocs.docc/Articles/Reference/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
vscode-swift provides various settings to configure its behaviour.
44

5-
> 💡 Tip: The Settings UI is common to all VS Code extensions. See the [VS Code documentation about personalizing VS Code](https://code.visualstudio.com/docs/getstarted/personalize-vscode) for a more in-depth overview.
5+
> 💡 Tip: The Settings Editor is common to all VS Code extensions. See the [documentation about personalizing VS Code](https://code.visualstudio.com/docs/getstarted/personalize-vscode) for a more in-depth overview.
66
77
The Swift extension comes with a number of settings you can use to control how it works. Detailed descriptions of each setting are provided in the extension settings page.
88

0 commit comments

Comments
 (0)