Skip to content

Commit

Permalink
Add additional JsPlugin documentation
Browse files Browse the repository at this point in the history
Follow-up to #4925
  • Loading branch information
devinrsmith committed Dec 14, 2023
1 parent aadf4c8 commit 2913b87
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions plugin/src/main/java/io/deephaven/plugin/js/JsPlugin.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@
* }
* </pre>
*
* and the file "/path-to/my-plugin/dist/index.js" would be served at "js-plugins/foo/dist/index.js". All other files of
* the form "/path-to/my-plugin/{somePath}" will be served at "js-plugins/foo/{somePath}".
* and all files of the form "/path-to/my-plugin/{somePath}" would be served at "js-plugins/foo/{somePath}".
*/
@Immutable
@BuildableStyle
Expand All @@ -55,8 +54,9 @@ public static Builder builder() {
}

/**
* The JS plugin name. The JS plugin contents will be served via the URL path "js-plugins/{name}/", as well as
* included as the "name" field for the manifest entry in "js-plugins/manifest.json".
* The JS plugin name. The JS plugin contents will be served under the URL path "js-plugins/{name}/", as well as
* included as the "name" field for the manifest entry in "js-plugins/manifest.json". The "/" character will not be
* URL encoded - the name "@example/foo" would be served under the URL path "js-plugins/@example/foo/".
*
* @return the name
*/
Expand Down

0 comments on commit 2913b87

Please sign in to comment.