Some stylistic changes in the JS compiler API change note

kaitai-io · Oct 21, 2023 · b3f2733 · b3f2733
1 parent 40a4ba4
commit b3f2733
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 9 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,10 +1,7 @@
 # 0.11 (TBD)
 
 * Packaging / infrastructure improvements:
-  * [npm package `kaitai-struct-compiler`](https://www.npmjs.com/package/kaitai-struct-compiler/) now
-    returns the compiler object itself instead of a constructor function (called `KaitaiStructCompiler`).
-    Make sure to adapt your code: replace `(new KaitaiStructCompiler()).compile(...)` to
-    `KaitaiStructCompiler.compile(...)` ([#222](https://github.com/kaitai-io/kaitai_struct_compiler/pull/222))
+  * [npm package `kaitai-struct-compiler`](https://www.npmjs.com/package/kaitai-struct-compiler/) now returns the compiler object itself instead of a constructor function (called `KaitaiStructCompiler`). Make sure to adapt your code: replace `(new KaitaiStructCompiler()).compile(...)` with `KaitaiStructCompiler.compile(...)` ([#222](https://github.com/kaitai-io/kaitai_struct_compiler/pull/222))
 
 # 0.10 (2022-07-08)
 

diff --git a/js/README.md b/js/README.md
@@ -54,11 +54,7 @@ Our [examples repository](https://github.com/kaitai-io/kaitai_struct_examples) c
 
 ## Plugging in
 
-> :information_source: Before the version 0.11.0 the `kaitai-struct-compiler`
-> module returned a _compiler constructor_ (called `KaitaiStructCompiler`) and
-> you would use it as `(new KaitaiStructCompiler()).compile(...)`, but since
-> 0.11.0 release it returns the _compiler object_ itself and you just need to
-> do `KaitaiStructCompiler.compile(...)`. Make sure to adapt your code.
+> **Note:** Before version 0.11.0, the `kaitai-struct-compiler` module returned a _compiler constructor_ (called `KaitaiStructCompiler`) and you would use it as `(new KaitaiStructCompiler()).compile(...)`, but since 0.11.0 it returns the _compiler object_ itself and you just need to do `KaitaiStructCompiler.compile(...)`. Make sure to adapt your code.
 
 We publish the compiler as a [UMD module](https://github.com/umdjs/umd), so it works from various environments, including server-side (e.g. Node.js) and client-side (e.g. web browser) ones.