Skip to content

Commit 0380d10

Browse files
committed
table viewer/linting docs
1 parent 73b1784 commit 0380d10

File tree

6 files changed

+34
-11
lines changed

6 files changed

+34
-11
lines changed

docs/make.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ makedocs(
1616
"Code Navigation" => "userguide/codenavigation.md",
1717
"Editing Code" => "userguide/editingcode.md",
1818
"Formatting Code" => "userguide/formatter.md",
19-
"Plot Gallery" => "userguide/plotgallery.md",
20-
"Data Grid" => "userguide/grid.md",
21-
"Understanding Code" => "userguide/understandingcode.md",
19+
"Plots" => "userguide/plotgallery.md",
20+
"Table Viewer" => "userguide/grid.md",
21+
# "Understanding Code" => "userguide/understandingcode.md",
2222
"Linter" => "userguide/linter.md",
23-
"Tasks" => "userguide/tasks.md",
23+
# "Tasks" => "userguide/tasks.md",
2424
"Debugging" => "userguide/debugging.md",
2525
"Compiling Sysimages" => "userguide/compilesysimage.md",
2626
"Julia Markdown Documents" => "userguide/weave.md",
27-
"Remote Development" => "userguide/remote.md",
28-
"Settings" => "userguide/settings.md"
27+
# "Remote Development" => "userguide/remote.md",
28+
# "Settings" => "userguide/settings.md"
2929
],
3030
"Change Log" => "changelog.md",
3131
"Developer Documentation" => Any[

docs/src/images/jet.png

114 KB
Loading

docs/src/images/table.png

132 KB
Loading

docs/src/userguide/grid.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
# Data Grid
1+
# Table Viewer
2+
3+
All [Tables.jl](https://github.com/JuliaData/Tables.jl)-compatible tables (and more!) can be displayed in the integrated table viewer.
4+
5+
You can use the exported `vscodedisplay` function to display an object directly or use the `Open in VS Code` button in the workspace:
6+
7+
![table viewer](../images/table.png)
8+
9+
`vscodedisplay` also takes an optional second argument that allows setting the tab title.
10+
11+
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).
12+
13+
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.
14+
15+
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.

docs/src/userguide/linter.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
# Linter
1+
# Linting and Diagnostics
2+
3+
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.
4+
5+
## Runtime diagnostics
6+
Packages like [JET.jl](https://github.com/aviatesk/JET.jl) can analyze code at runtime (for some defintion of "runtime"):
7+
![jet](../images/jet.png)
8+
9+
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.
10+
11+
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.

docs/src/userguide/plotgallery.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Plot Gallery
1+
# Plots
22

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

@@ -31,7 +31,7 @@ Let's walkthrough a simple program to understand this:
3131
Write the following code.
3232
```
3333
using Plots
34-
x = 1:10; y = rand(10); # These are the plotting data
34+
x = 1:10; y = rand(10); # These are the plotting data
3535
plot(x,y, label="my label")
3636
```
3737

@@ -40,4 +40,3 @@ Now `Run` this, you can follow the steps [here](https://www.julia-vscode.org/doc
4040
You will get something like the following graph as a output in a new tab in VS Code:
4141

4242
![Plot Graph](../images/PlotGallery/PlotGraph.png)
43-

0 commit comments

Comments
 (0)