diff --git a/CHANGELOG.md b/CHANGELOG.md index 527c8d2..ee05b4e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,9 @@ backward incompatible changes will start to apply when the projects goes 1.0 ## [Unreleased] + +## [0.15.0] (released: 2021-07-14) + ### Added - `forest.get_first_tree()` for efficiently unpacking tree 0 [7cb006c]. - `forest.disambiguate(callable)` for removing ambiguities from the forest [f4664af]. @@ -37,6 +40,7 @@ backward incompatible changes will start to apply when the projects goes 1.0 [6947942]: https://github.com/igordejanovic/parglare/commit/6947942 [65a1cbf]: https://github.com/igordejanovic/parglare/commit/65a1cbf + ## [0.14.0] (released: 2021-06-19) This release brings multiple new features and improvements. Read the [Release @@ -412,7 +416,8 @@ for more info. [#20]: https://github.com/igordejanovic/parglare/issues/20 -[Unreleased]: https://github.com/igordejanovic/parglare/compare/0.14.0...HEAD +[Unreleased]: https://github.com/igordejanovic/parglare/compare/0.15.0...HEAD +[0.15.0]: https://github.com/igordejanovic/parglare/compare/0.14.0...0.15.0 [0.14.0]: https://github.com/igordejanovic/parglare/compare/0.13.0...0.14.0 [0.13.0]: https://github.com/igordejanovic/parglare/compare/0.12.0...0.13.0 [0.12.0]: https://github.com/igordejanovic/parglare/compare/0.11.0...0.12.0 diff --git a/docs/release_notes/release_0_15.md b/docs/release_notes/release_0_15.md new file mode 100644 index 0000000..85b2bfc --- /dev/null +++ b/docs/release_notes/release_0_15.md @@ -0,0 +1,22 @@ +# Release notes for 0.15 + +This release should be fully backward compatible so the upgrade should require +no changes. + +## Greedy repetitions + +The most important new feature in this release is a support for greedy +repetition. Read more in [the docs](../../grammar_language/#greedy-repetitions). + +## New way to disambiguate the GLR forest + +A new and recommended way for dynamic disambiguation is by using +`forest.disambiguate`. Read more in [the docs](../../disambiguation/#disambiguation-of-a-glr-forest). + +## Optimized getting of the first tree from the GLR forest + +If you are not interested into analyzing the forest and comparing trees but just +want to get any valid tree you can use `forest.get_first_tree()` which is +optimized to avoid tree enumeration that might be costly. The returned tree is +fully unpacked and doesn't use proxies, i.e. it contains only `NodeTerm` and +`NodeNonTerm` instances. diff --git a/mkdocs.yml b/mkdocs.yml index 0971672..7b012f7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,6 +27,7 @@ nav: - pglr command: pglr.md - Debugging: debugging.md - Release Notes: + - 0.15: release_notes/release_0_15.md - 0.14: release_notes/release_0_14.md - About: - Contributing: about/CONTRIBUTING.md