Explorar o código

Merge pull request #64 from arawkins/wipdocs

Typo and grammar fixes
abakobo %!s(int64=8) %!d(string=hai) anos
pai
achega
4c5b58b933

+ 2 - 2
modules/monkey/docs/index/keywords-index.md

@@ -56,8 +56,8 @@ Used to skip a loop.
 
 #### CString
 
-Reserved keyword
-C style String for external string parameters
+Reserved keyword.
+C style String for external string parameters.
 
 #### Default
 

+ 1 - 1
modules/monkey/docs/language/conditional-statements.md

@@ -28,7 +28,7 @@ There may be any number of `ElseIf` blocks, or none. The final `Else` block is o
 
 `End` or `End If` may be used instead of `EndIf`, and `Else` If may be used instead of `ElseIf`.
 
-In addtion, a simple one line version of `If` is also supported:
+In addition, a simple one line version of `If` is also supported:
 
 `If` _Expression_ [ `Then` ] _Statement_ [ `Else` _Statement_ ]
 

+ 1 - 1
modules/monkey/docs/language/enums.md

@@ -2,7 +2,7 @@
 
 `Enum` is a data type containing a set of UInt constants.
 
-By default the members will receive  values starting from zero and incemented by one for each new member. You can assign a chosen value to each member when declaring them.
+By default the members will receive values starting from zero and incemented by one for each new member. You can assign a chosen value to each member when declaring them.
 
 ```
 Enum myBasicEnum

+ 1 - 1
modules/monkey/docs/language/language.md

@@ -13,7 +13,7 @@ Note: This documentation is currently WIP.
 @import arrays.md
 @import strings.md
 @import variants.md
-@import Enums.md
+@import enums.md
 @import variables.md
 @import pointers.md
 @import functions.md

+ 1 - 1
modules/monkey/docs/language/loop-statements.md

@@ -105,4 +105,4 @@ If Collection is an object, it must implement the std.collections.Icontainer int
 
 #### Continue
 
-Continue can be used within `While`, `Repea`t and `For` loops to force the loop to abruptly skip to the next loop iteration, skipping over any statements that may be remaining in the current loop iteration.
+Continue can be used within `While`, `Repeat` and `For` loops to force the loop to abruptly skip to the next loop iteration, skipping over any statements that may be remaining in the current loop iteration.

+ 10 - 10
modules/monkey/docs/language/pointers.md

@@ -1,10 +1,10 @@
 
 ### Pointers
 
-Pointers are special variables containing a memory adress.
+Pointers are special variables containing a memory address.
 In Monkey2 pointers are mainly used with external C/C++ code.
-It is not advised to use pointers if not necessary. It can lead to bug if the pointed adress is not kept "alive". Pointer to globals are safe for example.  
-You must have acces to the memory you try to reach or you'll have a (fatal) memory acces violation.
+Try not to use pointers unless absolutely necessary. It can lead to bugs if the pointed address is not kept "alive". Pointers to globals are safe, for example.  
+You must have access to the memory you're trying to reach or you'll have a (fatal) memory access violation.
 
 A pointer can point to any kind of type, even garbage collected types. This can lead to bad things too as the garbage collector is not 'aware' of pointers.
 
@@ -42,12 +42,12 @@ Local myPtr:int Ptr
 myPtr=VarPtr i
 Print myPtr[0]
 ```
-Will print 1, the value of i.
-Note you can use pointer arythmetics with the index operator([]) but you have to be sure you have access to that part of the memory or you'll get a memory acces violation!
+Will print 1, the value of `i`.
+Note you can use pointer arythmetics with the index operator(`[]`) but you have to be sure you have access to that part of the memory or you'll get a memory access violation!
 
 #### Dereferencing with ->
 
-You can acces user defined types fields, methods,.. with the `->` operator. It is equivalent to `[0].`
+You can access user defined types fields, methods,.. with the `->` operator. It is equivalent to `[0].`
 
 ```
 Struct str
@@ -62,13 +62,13 @@ Function Main()
    Print strPtr->i
 End
 ```
-will show the value of the struct's field i
+will show the value of the struct's field `i`
 
 #### Casting
 
 You can Cast a pointer and do some explicit conversions with the `Cast` operator.
 
-`Cast`<_Type_>(_adress_)
+`Cast`<_Type_>(_address_)
 
 An example with a useless conversion from Int to Void to Int:
 ```
@@ -83,5 +83,5 @@ Local myIntPtr:Int Ptr
 myIntPtr=Cast<Int Ptr>(myVoidPtr)
 j=myIntPtr[0]
 ```
-j receives to value of i but does not have the same adress.
-myIntPtr and myVoidPtr both points to the same adress(VarPtr i) but have different types.
+`j` receives the value of `i` but does not have the same address.
+`myIntPtr` and `myVoidPtr` both point to the same address (`VarPtr i`) but have different types.

+ 1 - 1
modules/monkey/docs/language/preprocessor.md

@@ -1,7 +1,7 @@
 
 ### Preprocessor
 
-Monkey2 include a simple preprocessor that allows you to conditionally compile code depending on a number of build setttings.
+Monkey2 includes a simple preprocessor that allows you to conditionally compile code depending on a number of build setttings.
 
 The preprocessor supports the following statements: #If, #Else, #ElseIf, #EndIf, #Rem, #End. Preprocessor statements must begin on a new line.