Skip to content

Commit 135324d

Browse files
authored
Fix typographic errors in CHANGELOG.md (#123)
1 parent 629f9ec commit 135324d

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

CHANGELOG.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ changes. These have been tagged in the changelog.
6969

7070
* [TRLC] New command-line flag `-I` which can be used to register
7171
include directories. You can use this to automatically parse a
72-
minimal set of file. Normally when invoking eg `trlc foo.trlc` this
72+
minimal set of file. Normally when invoking e.g. `trlc foo.trlc` this
7373
will fail, because you did not provide e.g. `foo.rsl`.
7474

7575
With the `-I` flag you can now automatically let the tool discover
@@ -85,8 +85,8 @@ changes. These have been tagged in the changelog.
8585
which should be used before any `register_file` or `register_dir`
8686
calls.
8787

88-
* [API] *When using includes*, the symbol table will contains packages
89-
for every discovered package. These are indistinguisable from normal
88+
* [API] *When using includes*, the symbol table will contain packages
89+
for every discovered package. These are indistinguishable from normal
9090
(but empty) packages, so if you're relying on iterating over all
9191
known packages you will find a lot of unused and empty ones now. If
9292
the include mechanism is not used, then there is no change in
@@ -129,7 +129,7 @@ changes. These have been tagged in the changelog.
129129
[CVC5](https://pypi.org/project/cvc5) instead.
130130

131131
* [TRLC] Remove the `--lint` option. Lint messages are now enabled by
132-
default, and `.trlc` files are processed as well. Instead there is a
132+
default, and `.trlc` files are processed as well. Instead, there is a
133133
`--no-lint` option which turns off the extra warnings.
134134

135135
* [TRLC] Add the `--skip-trlc-files` option which disables processing
@@ -185,7 +185,7 @@ changes. These have been tagged in the changelog.
185185
like the `'''` strings, these can contain newlines.
186186

187187
* [TRLC, LRM] User defined checks are now not allowed to contain a
188-
newline. However you can now provide additional information that
188+
newline. However, you can now provide additional information that
189189
_can_ contain a newline. For example:
190190

191191
```trlc
@@ -216,7 +216,7 @@ changes. These have been tagged in the changelog.
216216
* [TRLC] Add support for Python 3.11. We now support Python 3.8 up to
217217
and including 3.11.
218218

219-
* [TRLC] Add new option `--no-detailed-info` which supresses the
219+
* [TRLC] Add new option `--no-detailed-info` which suppresses the
220220
additional information the linter may add to a message, such as
221221
counter-examples or reasoning.
222222

@@ -286,12 +286,12 @@ changes. These have been tagged in the changelog.
286286
encoding. We now print an error message indicating the issue.
287287

288288
* [TRLC] Fix bug when parsing arrays: arrays without comma separators
289-
were accapted when they should have been rejected.
289+
were accepted when they should have been rejected.
290290

291291
* [TRLC] Fix tool crash when parsing a file with an unterminated `/*`
292292
comment.
293293

294-
* [LRM] Fix typo in in several places: `.rls` should be `.rsl`.
294+
* [LRM] Fix typo in several places: `.rls` should be `.rsl`.
295295

296296
### 1.1.6
297297

@@ -330,8 +330,7 @@ changes. These have been tagged in the changelog.
330330

331331
* [Package] Provide Linux and OSX packages, along with the default
332332
package, which should automatically install PyVCG where it is
333-
available. On Windows, `pip` should fall back to the platform
334-
agnostic package.
333+
available. On Windows, `pip` should fall back to the platform-agnostic package.
335334

336335
* [TRLC] Add new option `--no-user-warnings` to suppress any warning
337336
generated from a user-defined check.
@@ -386,9 +385,9 @@ changes. These have been tagged in the changelog.
386385

387386
### 1.1.4
388387

389-
* [TRLC] Improve error messages by using a more human readable form of
390-
expected tokens, so now you see "opening brace '{'" instead of
391-
"C_BRA".
388+
* [TRLC] Improve error messages by using a more human-readable form of
389+
expected tokens, so now you see `opening brace '{'` instead of
390+
`C_BRA`.
392391

393392
### 1.1.3
394393

@@ -416,7 +415,7 @@ changes. These have been tagged in the changelog.
416415
generic datatype, for specifying e.g. coordinates, qualified
417416
information, complex numbers, vectors, etc.
418417

419-
Have a look at the new [Tuples Tutorial](TUTORIAL-TUPLES.md) for
418+
Have a look at the new [Tuples Tutorial](documentation/TUTORIAL-TUPLES.md) for
420419
some examples.
421420

422421
* [LRM, TRLC] Support for freezing record components: you can now
@@ -426,14 +425,14 @@ changes. These have been tagged in the changelog.
426425
overwritten, or unfrozen again.
427426

428427
Have a look at the updated [Catch-all base types
429-
tutorial](TUTORIAL-OPTIONAL-BASE.md) for an example.
428+
tutorial](documentation/TUTORIAL-OPTIONAL-BASE.md) for an example.
430429

431430
* [LRM, TRLC] Support for abstract and final types: abstract must be
432431
extended before they can be used, and final types cannot gain new
433432
components.
434433

435-
Have a look at the new [Advaned tips &
436-
tricks](TUTORIAL-ADVANCED-TYPES.md) tutorial for examples.
434+
Have a look at the new [Advanced tips &
435+
tricks](documentation/TUTORIAL-ADVANCED-TYPES.md) tutorial for examples.
437436

438437
* [TRLC] Introducing the tuple type required significant
439438
reorganisation of the AST, to mark this significant backwards
@@ -497,7 +496,7 @@ changes. These have been tagged in the changelog.
497496
correctly yourself.
498497

499498
* [TRLC, LRM] new type `Markup_String` which is a special kind of
500-
`String` that behaves in exactly the same way. However you reference
499+
`String` that behaves in exactly the same way. However, you reference
501500
other TRLC records directly: `for example see [[potato,
502501
package.wibble]]`. These references are checked and validated by
503502
TRLC.
@@ -506,8 +505,8 @@ changes. These have been tagged in the changelog.
506505

507506
* [TRLC] You can now provide more than one directory on the
508507
command-line to process, as well as individual files. If no files or
509-
directories are provided the default is now to analyse the currenty
510-
directory `.` including all sub-directories.
508+
directories are provided the default is now to analyse the current
509+
directory `.` including all subdirectories.
511510

512511
* [TRLC] In error messages that reference another file+location more
513512
of the path is now shown to help you find the problem. For example
@@ -526,9 +525,9 @@ changes. These have been tagged in the changelog.
526525

527526
* [LRM] The LRM for TRLC is [now written in
528527
TRLC](https://github.com/bmw-software-engineering/trlc/tree/main/language-reference-manual). There
529-
is also a [HTML
528+
is also an [HTML
530529
version](https://bmw-software-engineering.github.io/trlc/lrm.html)
531-
available for easier reading. During conversion we fixed a number of
530+
available for easier reading. During conversion, we fixed a number of
532531
issues in the LRM (missing keywords, etc.) and made a few cleanups
533532
and simplifications; however the language and its semantics have not
534533
changed.
@@ -588,7 +587,7 @@ changes. These have been tagged in the changelog.
588587

589588
* [TRLC] Add two new API functions (a [simpler
590589
lookup](https://bmw-software-engineering.github.io/trlc/manual/ast.html#trlc.ast.Symbol_Table.lookup_assuming)
591-
and [inheritence
590+
and [inheritance
592591
checking](https://bmw-software-engineering.github.io/trlc/manual/ast.html#trlc.ast.Record_Type.is_subclass_of)
593592
for record types).
594593

0 commit comments

Comments
 (0)