diff --git a/docs/make.jl b/docs/make.jl index fbfd2d7..e5ecbd4 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -16,16 +16,16 @@ makedocs( "Code Navigation" => "userguide/codenavigation.md", "Editing Code" => "userguide/editingcode.md", "Formatting Code" => "userguide/formatter.md", - "Plot Gallery" => "userguide/plotgallery.md", - "Data Grid" => "userguide/grid.md", - "Understanding Code" => "userguide/understandingcode.md", + "Plots" => "userguide/plotgallery.md", + "Table Viewer" => "userguide/grid.md", + # "Understanding Code" => "userguide/understandingcode.md", "Linter" => "userguide/linter.md", - "Tasks" => "userguide/tasks.md", + # "Tasks" => "userguide/tasks.md", "Debugging" => "userguide/debugging.md", "Compiling Sysimages" => "userguide/compilesysimage.md", "Julia Markdown Documents" => "userguide/weave.md", - "Remote Development" => "userguide/remote.md", - "Settings" => "userguide/settings.md" + # "Remote Development" => "userguide/remote.md", + # "Settings" => "userguide/settings.md" ], "Change Log" => "changelog.md", "Developer Documentation" => Any[ diff --git a/docs/src/images/jet.png b/docs/src/images/jet.png new file mode 100644 index 0000000..fbd2b7a Binary files /dev/null and b/docs/src/images/jet.png differ diff --git a/docs/src/images/table.png b/docs/src/images/table.png new file mode 100644 index 0000000..97ae113 Binary files /dev/null and b/docs/src/images/table.png differ diff --git a/docs/src/userguide/grid.md b/docs/src/userguide/grid.md index d6cda0c..cdbd625 100644 --- a/docs/src/userguide/grid.md +++ b/docs/src/userguide/grid.md @@ -1 +1,15 @@ -# Data Grid +# Table Viewer + +All [Tables.jl](https://github.com/JuliaData/Tables.jl)-compatible tables (and more!) can be displayed in the integrated table viewer. + +You can use the exported `vscodedisplay` function to display an object directly or use the `Open in VS Code` button in the workspace: + +![table viewer](../images/table.png) + +`vscodedisplay` also takes an optional second argument that allows setting the tab title. + +Tables can be filtered and sorted in the UI, although that may be slow for medium sized tables and is disabled for big tables (with more than 1e7 elements). + +Note that not-big tables (by the above definition) are cached. As such, changes to the original data structure won't be reflected in the table viewer until you display the table again. + +A slightly hidden feature is that you can select rows and copy them into the clipboard with Ctrl-C or the context menu. Note that this will be slow when many rows are selected. diff --git a/docs/src/userguide/linter.md b/docs/src/userguide/linter.md index 7f92dfc..c7cb967 100644 --- a/docs/src/userguide/linter.md +++ b/docs/src/userguide/linter.md @@ -1 +1,11 @@ -# Linter +# Linting and Diagnostics + +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"): +![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. + +Package authors who want to use this feature can simply implement a type that supports the `application/vnd.julia-vscode.diagnostics` MIME type. Check `VSCodeServer.DIAGNOSTIC_MIME` in a the integrated Julia REPL for more information on the API. diff --git a/docs/src/userguide/plotgallery.md b/docs/src/userguide/plotgallery.md index 3fe518e..a51f0b6 100644 --- a/docs/src/userguide/plotgallery.md +++ b/docs/src/userguide/plotgallery.md @@ -1,4 +1,4 @@ -# Plot Gallery +# Plots Julia `Plots` provides us with the capability to create visualizations of data. @@ -31,7 +31,7 @@ Let's walkthrough a simple program to understand this: Write the following code. ``` using Plots -x = 1:10; y = rand(10); # These are the plotting data +x = 1:10; y = rand(10); # These are the plotting data plot(x,y, label="my label") ``` @@ -40,4 +40,3 @@ Now `Run` this, you can follow the steps [here](https://www.julia-vscode.org/doc You will get something like the following graph as a output in a new tab in VS Code: ![Plot Graph](../images/PlotGallery/PlotGraph.png) -