Merge pull request #525 from informalsystems/shon/fix-change-notes

Fix change log notes

UNRELEASED.md

@@ -10,25 +10,23 @@
          * Another change description, see #124
 
      DO NOT LEAVE A BLANK LINE BELOW THIS PREAMBLE -->
-### Feature Model Checker
+### Features
 
- * new sequential model checker that is using TransitionExecutor, see #467
- * new command-line options, see #467 and the manual for details:
-   - choose the algorithm: `--algo=(offline|incremental)`
-   - pre-check, whether a transition disabled, discard the disabled transitions: `--discard-disabled`
-   - do not check for deadlocks: `--no-deadlock`
-   - pass tuning parameters in CLI: `--tune-here`
+* new sequential model checker that is using TransitionExecutor, see #467
+* new command-line options, see #467 and the manual for details:
+  * choose the algorithm: `--algo=(offline|incremental)`
+  * pre-check, whether a transition disabled, discard the disabled transitions: `--discard-disabled`
+  * do not check for deadlocks: `--no-deadlock`
+  * pass tuning parameters in CLI: `--tune-here`
+* parsing in-comment Java-like annotations, see #226
+* tracking the source of variable/constant declarations and operator
+  definitions in the TLA+ Parser, see #262
 
-### Feature TLA+ Parser (SANY importer)
+### Bug fixes
 
-  * parsing in-comment Java-like annotations, see #226
-  * tracking the source of variable/constant declarations and operator definitions, see #262
-
-### Bugfixes
-
- * the new sequential model checker has uncovered a bug that was not found
-   by the old model checker, see #467
+* the new sequential model checker has uncovered a bug that was not found
+  by the old model checker, see #467
 
 ### Documentation
 
-  * ADR004: In-comment annotations for declarations (of constants, variables, operators)
+* ADR004: In-comment annotations for declarations (of constants, variables, operators)

script/release-notes.sh

@@ -19,13 +19,13 @@ RELEASE_VERSION=${RELEASE_VERSION:-''}
 PREAMBLE="<!-- NOTE:
      Release notes for unreleased changes go here, following this format:
 
-        ### Feature Category 1
+        ### Features
 
          * Change description, see #123
 
-        ### Feature Category 2
+        ### Bug fixes
 
-         * Another change description, see #124
+         * Some bug fix, see #124
 
      DO NOT LEAVE A BLANK LINE BELOW THIS PREAMBLE -->"