Merge pull request #62 from pitmonticone/master

Clean README, CONTRIBUTING and user guide.

Author: pfitzseb

CONTRIBUTING.md

@@ -1,3 +1,3 @@
 # Contributing Guide
 
-Whenever posssible, we prefer to follow the expectations specified by the Visual Studio Code contributing guide. Please refer to the [VS Code Contributing guide](https://github.com/microsoft/vscode-docs/blob/main/CONTRIBUTING.md) for more details around best practices.
+Whenever possible, we prefer to follow the expectations specified by the Visual Studio Code contributing guide. Please refer to the [VS Code Contributing guide](https://github.com/microsoft/vscode-docs/blob/main/CONTRIBUTING.md) for more details around best practices.

README.md

@@ -6,12 +6,11 @@
 
 This repository contains the documentation for the [julia VS Code extension](https://marketplace.visualstudio.com/items?itemName=julialang.language-julia).
 
-
 ## Contributing to the Documentation
 
 In order to contribute to the documentation, simply modify the files in the `/docs/src` folder and open a PR against the `master` branch.
 Once a PR has been opened, the CI will automatically run [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) and generate a new documentation against the PR.
-You can see the generate documentation on `https://www.julia-vscode.org/docs/previews/PR##`, where `##` is your PR's number.
+You can see the generated documentation on `https://www.julia-vscode.org/docs/previews/PR##`, where `##` is your PR's number.
 
 Please refer to the VS Code contributing guide [here](https://github.com/microsoft/vscode-docs/blob/main/CONTRIBUTING.md) for details on best practices and how to refer to VS Code correctly.
 

docs/src/userguide/compilesysimage.md

@@ -16,14 +16,14 @@ This file should be named `./.vscode/JuliaSysimage.toml` and be placed under the
 
 ```
 [sysimage]
-exclude=["Pkg1", "Pkg2"]   # Additional packages to be exlucded in the system image
+exclude=["Pkg1", "Pkg2"]   # Additional packages to be excluded in the system image
 statements_files=["relative/path/to/precompile_statements_file.jl", ]
 execution_files="relative/path/to/precompile_excecution_file.jl"
 ```
-The packages to be excluded have to be seperated by commas, each with quotation marks and all inside square brackets.
-The path should be relative to the currently active folder, which can be selected by the command `File: Open Folder...`. The statement or excecution files can be given as a single relative path, or as a list of relative paths.
+The packages to be excluded have to be separated by commas, each with quotation marks and all inside square brackets.
+The path should be relative to the currently active folder, which can be selected by the command `File: Open Folder...`. The statement or execution files can be given as a single relative path, or as a list of relative paths.
 
-The statement files should contain precompile statements of the form `precompile(Tuple{typeof(Base.sin), Float64})`, and the excecution files should contain function calls for which the methods should be compiled. 
+The statement files should contain precompile statements of the form `precompile(Tuple{typeof(Base.sin), Float64})`, and the execution files should contain function calls for which the methods should be compiled. 
 
 The build task creates a sysimage that includes all packages in the current Julia environment. This sysimage is saved in the same folder where the `Project.toml` and `Manifest.toml` of the current Julia environment are stored. The name of the sysimage file will be `JuliaSysimage.dll` (Windows) or `JuliaSysimage.so`. 
 

docs/src/userguide/linter.md

@@ -3,7 +3,7 @@
 All Julia code in the workspace is statically linted. You can disable that feature with the `julia.lint.run` setting or configure it via various options with the `julia.lint.` prefix.
 
 ## Runtime diagnostics
-Packages like [JET.jl](https://github.com/aviatesk/JET.jl) can analyze code at runtime (for some defintion of "runtime"):
+Packages like [JET.jl](https://github.com/aviatesk/JET.jl) can analyze code at runtime (for some definition of "runtime"):
 ![jet](../images/jet.png)
 
 You can opt out of this feature with the `julia.showRuntimeDiagnostics` setting. Use `Julia: Clear Runtime Diagnostics` or `Julia: Clear Runtime Diagnostics by Provider` to clear the displayed diagnostics.

docs/src/userguide/runningcode.md

@@ -56,4 +56,4 @@ This command runs the entire content of the currently active file in the Julia R
 
 ### Julia: Run File in New Process
 
-Sometimes it's desirable to run your code in a new process (e.g. if you want to be absolutely sure that no state from previosuly run code interferes), so this command will spawn a new Julia process and run the active file in it.
+Sometimes it's desirable to run your code in a new process (e.g. if you want to be absolutely sure that no state from previously run code interferes), so this command will spawn a new Julia process and run the active file in it.