Skip to content

Commit

Permalink
table viewer/linting docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pfitzseb committed Dec 14, 2021
1 parent 73b1784 commit 0380d10
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 11 deletions.
12 changes: 6 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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[
Expand Down
Binary file added docs/src/images/jet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/images/table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 15 additions & 1 deletion docs/src/userguide/grid.md
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 11 additions & 1 deletion docs/src/userguide/linter.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 2 additions & 3 deletions docs/src/userguide/plotgallery.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Plot Gallery
# Plots

Julia `Plots` provides us with the capability to create visualizations of data.

Expand Down Expand Up @@ -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")
```

Expand All @@ -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)

0 comments on commit 0380d10

Please sign in to comment.