Skip to content

Commit

Permalink
add dev note to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IanButterworth authored Feb 4, 2023
1 parent 34cbd96 commit 129c991
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ getstore(ssi::SymbolServerInstance, environment_path::AbstractString)
Loads the symbols for the environment in `environment_path`. Returns a tuple, where the first element is a return status and the second element a payload. The status can be `:success` (in which case the second element is the new store), `:canceled` if another call to `getstore` was initiated before a previous one finished (with `nothing` as the payload), or `:failure` with the payload being the content of the error stream of the client process.

This function is long running and should typically be called in an `@async` block.

## Development of the VSCode extension

See https://github.com/julia-vscode/julia-vscode/wiki for information on how to test this package with the VSCode extension

0 comments on commit 129c991

Please sign in to comment.