summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAdrian Thurston <thurston@colm.net>2019-09-13 07:30:02 -0600
committerGitHub <noreply@github.com>2019-09-13 07:30:02 -0600
commit99c75aa9227efe3c2bfb7959dc0c2b7825a03d8b (patch)
tree490de2c73247a62aeb764c2972cd92a6504530bf /doc
parent2f7331772690af0f9fb189d735c04ad7263f489b (diff)
parent45c11a0a88b7d6acd543c7c473955c4bbc968906 (diff)
downloadcolm-99c75aa9227efe3c2bfb7959dc0c2b7825a03d8b.tar.gz
Merge pull request #2 from phorward/phorward
Fixing some typos in existing docs
Diffstat (limited to 'doc')
-rw-r--r--doc/colm/0_00_welcome.adoc2
-rw-r--r--doc/colm/0_01_installing.adoc8
-rw-r--r--doc/colm/0_05_fizzbuzz.adoc6
-rw-r--r--doc/colm/0_06_scope.adoc2
-rw-r--r--doc/colm/2_02_list_map_struct_alias.adoc2
-rw-r--r--doc/colm/2_03_def.adoc2
6 files changed, 11 insertions, 11 deletions
diff --git a/doc/colm/0_00_welcome.adoc b/doc/colm/0_00_welcome.adoc
index 12f974b2..93b446d2 100644
--- a/doc/colm/0_00_welcome.adoc
+++ b/doc/colm/0_00_welcome.adoc
@@ -41,5 +41,5 @@ Colm's development started by https://twitter.com/ehdtee[Adrian Thurston] during
=== When not to use Colm
Colm is meant to create executables or object files that can be linked in other programs.
-This make is ideal for tasks like high performance transformations, but not very convienient for throwaway-oneliners that are common with tools like 'sed' or 'awk'.
+This make is ideal for tasks like high performance transformations, but not very convenient for throwaway-oneliners that are common with tools like 'sed' or 'awk'.
diff --git a/doc/colm/0_01_installing.adoc b/doc/colm/0_01_installing.adoc
index af8fbf0d..8d73f710 100644
--- a/doc/colm/0_01_installing.adoc
+++ b/doc/colm/0_01_installing.adoc
@@ -33,9 +33,9 @@ It works!
When we look a little bit closer we see that colm:
* is able to be build as a static and/or shared libray.
-* is licenced under GPL 2
-* is equiped with a vim syntax highlighting file
-* is using the aapl (LGPL 2.1 licenced) library from Adrian Thurston (just like ragel does).
+* is licenced under MIT
+* is equipped with a vim syntax highlighting file
+* is using the aapl (MIT licenced) library from Adrian Thurston (just like ragel does).
* There is one file in the repository that stands out: 'colm.lm'
- In the Ragel repository there are also serveral '.lm' files. And it's syntax looks like the colm language that is presented in the thesis.
+ In the Ragel repository there are also several '.lm' files. And it's syntax looks like the colm language that is presented in the thesis.
diff --git a/doc/colm/0_05_fizzbuzz.adoc b/doc/colm/0_05_fizzbuzz.adoc
index 6e30279e..fc612943 100644
--- a/doc/colm/0_05_fizzbuzz.adoc
+++ b/doc/colm/0_05_fizzbuzz.adoc
@@ -35,7 +35,7 @@ hello 9 4
== Real FizzBuzz
-The fizzbuzz test is often used to check is someone has programming skils.
+The fizzbuzz test is often used to check if someone has programming skills.
It is the next logical step to 'hello world'.
[source,chapel]
@@ -46,11 +46,11 @@ include::code/fizzbuzz.lm[]
It appears that there is no modulo operator ('%').
Therefor we'll resort to a function.
-Writing a function seems rather straight forward
+Writing a function seems rather straight forward.
Please note:
* that '&&' is working.
-* The return type is needed, but if 'nil' is retuned by default.
+* The return type is needed, but if 'nil' is returned by default.
[source,bash]
----
diff --git a/doc/colm/0_06_scope.adoc b/doc/colm/0_06_scope.adoc
index 2c411a61..3c0a9e42 100644
--- a/doc/colm/0_06_scope.adoc
+++ b/doc/colm/0_06_scope.adoc
@@ -1,7 +1,7 @@
Scope
=====
-We saw in the previous paragraph that functions can be used, and that they can have parameter.
+We saw in the previous paragraph that functions can be used, and that they can have parameters.
This forces us to clarify 'scope'.
[source,chapel]
diff --git a/doc/colm/2_02_list_map_struct_alias.adoc b/doc/colm/2_02_list_map_struct_alias.adoc
index adaccc7f..994a5c98 100644
--- a/doc/colm/2_02_list_map_struct_alias.adoc
+++ b/doc/colm/2_02_list_map_struct_alias.adoc
@@ -2,7 +2,7 @@ List, Map, Struct and alias
===========================
Next to the basic types, there are the normal things that we can expect from scripting languages.
-As colm is static and strong typed, it is very convienient to use alias as well.
+As colm is static and strong typed, it is very convenient to use alias as well.
An example is probably much clearer then 1000 loc.
diff --git a/doc/colm/2_03_def.adoc b/doc/colm/2_03_def.adoc
index 0ef66ae8..a472149d 100644
--- a/doc/colm/2_03_def.adoc
+++ b/doc/colm/2_03_def.adoc
@@ -1,7 +1,7 @@
Def
===
-The 'def' is where colm realy shines.
+The 'def' is where colm really shines.
A 'def' is somewhere between a struct and a regular expression.
Again one example is much more clearer.