diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07a0a275..04002ad7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,10 +11,10 @@ The repository is organized as follows: . ├── optuna_dashboard/ # The Python package. │ └── ts/ # TypeScript code for the Python package. -├── standalone_app/ # Standalone application that can be run in browser or within the WebView of the VSCode extension. +├── standalone_app/ # Standalone application that can be run in browser or within the WebView of the VS Code extension. │ ├── browser_app_entry.tsx # Entry point for browser app, hosted on GitHub pages. -│ └── vscode_entry.tsx # Entry point for VSCode app, output placed under `vscode/assets`. -├── vscode/ # The VSCode extension. +│ └── vscode_entry.tsx # Entry point for VS Code app, output placed under `vscode/assets`. +├── vscode/ # The VS Code extension. └── rustlib/ # Rust library exporting Wasm functions. └── pkg/ # Output directory for rustlib, installed from package.json via `"./rustlib/pkg"`. ``` @@ -133,7 +133,7 @@ $ make serve-browser-app Open http://127.0.0.1:9000/ -## VSCode Extension +## VS Code Extension ``` $ npm i -g vsce diff --git a/README.md b/README.md index 91358aa7..4b38f863 100644 --- a/README.md +++ b/README.md @@ -75,13 +75,13 @@ $ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard postgresql+ps -## VSCode Extension (Experimental) +## VS Code Extension (Experimental) -You can install the VSCode extension via [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Optuna.optuna-dashboard#overview). +You can install the VS Code extension via [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Optuna.optuna-dashboard#overview). ![vscode-extension](./docs/_static/vscode-extension.png) -Please right-click the SQLite3 files (`*.db` or `*.sqlite3`) in the VSCode file explorer and select the "Open in Optuna Dashboard" command from the dropdown menu. +Please right-click the SQLite3 files (`*.db` or `*.sqlite3`) in the VS Code file explorer and select the "Open in Optuna Dashboard" command from the dropdown menu. ## Features diff --git a/docs/getting-started.rst b/docs/getting-started.rst index 9d96cce5..e45b6f86 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -202,13 +202,13 @@ you can use ``google.colab.output()`` function as follows: Then please open http://localhost:8081/dashboard to browse. -VSCode (Experimental) ---------------------- +VS Code (Experimental) +---------------------- -You can install the VSCode extension via `Visual Studio Marketplace `_. +You can install the VS Code extension via `Visual Studio Marketplace `_. .. image:: _static/vscode-extension.png - :alt: Screenshot for the VSCode Extension + :alt: Screenshot for the VS Code Extension :align: center -Please right-click the SQLite3 files (`*.db` or `*.sqlite3`) in the VSCode file explorer and select the "Open in Optuna Dashboard" command from the dropdown menu. +Please right-click the SQLite3 files (`*.db` or `*.sqlite3`) in the file explorer and select the "Open in Optuna Dashboard" command from the dropdown menu. diff --git a/vscode/README.md b/vscode/README.md index f5dc14c3..78587c37 100644 --- a/vscode/README.md +++ b/vscode/README.md @@ -1,4 +1,4 @@ -# Optuna Dashboard for VSCode +# Optuna Dashboard for VS Code The Optuna Dashboard extension lets you open Optuna's SQLite3 database in Optuna Dashboard, allowing users to see optimization histories in graphs and tables. @@ -6,7 +6,7 @@ The Optuna Dashboard extension lets you open Optuna's SQLite3 database in Optuna ## Usage -Please right-click on the SQLite3 file (`*.db` or `*.sqlite3`) in the VSCode file explorer and select the "Open in Optuna Dashboard" command from the dropdown menu. +Please right-click on the SQLite3 file (`*.db` or `*.sqlite3`) in the file explorer and select the "Open in Optuna Dashboard" command from the dropdown menu. ## Extension Settings diff --git a/vscode/src/web/extension.ts b/vscode/src/web/extension.ts index 3b797350..096c2337 100644 --- a/vscode/src/web/extension.ts +++ b/vscode/src/web/extension.ts @@ -8,7 +8,7 @@ export function activate(context: vscode.ExtensionContext) { let disposable = vscode.commands.registerCommand( "optuna-dashboard.openOptunaDashboard", async (fileUri: vscode.Uri) => { - // In VSCode, the path separator of fileUri is always '/' + // In VS Code, the path separator of fileUri is always '/' // even when using Windows. const title = fileUri.path.split("/").pop() || "Optuna Dashboard" const panel = vscode.window.createWebviewPanel(