From 62353eea9a0002da87ba1c6b58f89710de22169e Mon Sep 17 00:00:00 2001 From: Will Speak Date: Sun, 10 Feb 2019 11:32:15 +0000 Subject: [PATCH] Doc Typo Fixes Fixup some mis-spellings and other minor doc issues. --- LICENSE.md | 2 +- README.md | 4 ++-- STRUCTURE.md | 2 +- docs/10-syntax.md | 8 -------- docs/15-data-layout.md | 2 +- 5 files changed, 5 insertions(+), 13 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index bb98343..801334b 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -9,4 +9,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 049edc0..6410c16 100644 --- a/README.md +++ b/README.md @@ -51,10 +51,10 @@ Ullage is open source, under the [MIT License](LICENSE.md). ### Lexer - * [x] Recognise words, numbers, comments, operators and whitespace + * [x] Recognise words, numbers, comments, operators and white-space * [x] Position information on each token * [ ] Interpolated strings - * [ ] Expose whitespace to the parser + * [x] Expose whitespace to the parser ### Parser diff --git a/STRUCTURE.md b/STRUCTURE.md index f77c7c3..6c4d012 100644 --- a/STRUCTURE.md +++ b/STRUCTURE.md @@ -8,7 +8,7 @@ The language parser and compiler are written in Rust. The source lives in the `s Functional tests for the language consist of a set of source files in `spec/`. These files contain specially formatted comments which are interpreted by the Python test runner `specs.py` when run. -Documentation, written in Markdown, is in the `docs/` folder. It can be compiled into a static side with [`docket`](http://willspeak.me/docket/). +Documentation, written in Markdown, is in the `docs/` folder. It can be compiled into a static site with [`docket`](http://willspeak.me/docket/). ## Rust modules diff --git a/docs/10-syntax.md b/docs/10-syntax.md index 32941f8..61f0faf 100644 --- a/docs/10-syntax.md +++ b/docs/10-syntax.md @@ -170,14 +170,6 @@ print add(add(1, 2), 3) # => 6 The following grammar defines the language: -``` -def foo(bar): - pass -``` - - - :::python - identifier = WORD ; diff --git a/docs/15-data-layout.md b/docs/15-data-layout.md index 2d92e7f..89d2385 100644 --- a/docs/15-data-layout.md +++ b/docs/15-data-layout.md @@ -38,4 +38,4 @@ Rather than aiming to control access to data as Rust does the language should pr * Reference counting. E.g. Swift's ARC & Python. * Simple mark & sweep GC. - For a full mark and sweep or other collector the code generated needs to insert GC statepoints. For this reason i'm tempted to head towards the second option. I place of statepoints we will need to decide in the lower pass where to insert RC retain and release code to maintain the count. Could this work the same way as Rust's ARC model? In that case the code just needs to know a fixed point in the scope where each value is deallocated. +For a full mark and sweep or other collector the code generated needs to insert GC statepoints. For this reason i'm tempted to head towards the second option. I place of statepoints we will need to decide in the lower pass where to insert RC retain and release code to maintain the count. Could this work the same way as Rust's ARC model? In that case the code just needs to know a fixed point in the scope where each value is deallocated.