Skip to content

Various typos in the Eve language handbook #36

Closed
@Ivo-Balbaert

Description

@Ivo-Balbaert

I like Eve very much and worked through the Quickstart and handbook. I noticed a number of typos, most of them only spelling, a few in code examples itself. While "it is low hanging fruit", correcting them will give new users an even better experience, so I list them here:

(1) http://docs.witheve.com/handbook/is/
“The output shows that y is false while z is true.”

This is incorrect, the output is false and 10.
The code should be rewritten as: [#div text: "z is {{z}}"]

(2) Typo:
http://docs.witheve.com/handbook/functions/

“Also like records, arguments are stateted explicitly.”
Should be:
“Also like records, arguments are stated explicitly.”

angles in randians
should be:
angles in radians

(3) tictacto.eve:
product of their values. This means that if i = {0, 1, 2} and j = {0, 1, 2}, then i x j = {(1, 1), (1, 2), ... (3, 2), (3, 3)}. These are exactly the indices we need for our grid!

Should be: This means that if i = {1, 2, 3} and j = {1, 2, 3},

(4) http://docs.witheve.com/handbook/records/
Records are the predominate datatype in Eve
Should be:
Records are the predominant

(5) http://docs.witheve.com/guides/style/
Still uses match instead of search in:
// Good
match
[...]

bind
[...]

(6) Quickstart example:
search
schools = [#school address]
students = [#student school: school.name]

bind @browser
[#div text: "{{students.name}} attends {{schools.name}} at {{address}}"]

students = [#student school: school.name]
should be:
students = [#student school: schools.name]

(7) Quickstart:

celia = [name: "Celia"]
Uses the wrong double quotes character " from Word probably; which can give wrong program execution. This occurs at several places, it

(8) Quickstart: This block selects all students, and uses and if-then expression to set the student's
Should be an

(9) Quickstart:: calculated-age = if student.age then student.age
else if student.grade then student.grade + 5

Why so complicated and not just:

calculated-age = if student.grade then student.grade + 5
(10) http://docs.witheve.com/handbook/records/

commit
[name: "Jeremey" spouse: [name: "Wendy"]]

"Jeremey" should be "Jeremy"

(11) http://docs.witheve.com/handbook/not/

friends not invited to the party
friends = [#friend]
not(friends = [#invited])

should be: // friends not invited to the party

(12) http://docs.witheve.com/handbook/joins/:
joins allow you to relate two records

(13)
http://docs.witheve.com/handbook/math/floor/
search
y = floor[value: 34.2]

bind @browser
[#div text: value]

Should be:
bind @browser
[#div text: y]

(14)
http://docs.witheve.com/handbook/bind/

Display a formatted time:
match
[#time hours minutes seconds]
(am/pm, adjusted-hours) = if hours >= 12 then ("PM", hours - 12)
else if hours = 0 then ("AM", 12)
else ("AM", hours)
match should be search

(15) http://docs.witheve.com/handbook/functions/
[#fn #function argument1, ... argumentN, value1, ..., valueN]

Should this not be: [#fn #function argument1: value1, ... argumentN: valueN, return: value]

(16) http://docs.witheve.com/handbook/functions/
The example in Set Semantics is correct, but does not illustrate any function, merely string embedding. It belongs probably in the docs for sets.

(17) http://docs.witheve.com/handbook/if-then/
In the syntax format: (value, ..., valueN) should be (value1, ..., valueN)

[@"my party" date]
Should be [#"my party" date]

burgers = if guest = [@Arthur] then 3
should be #Arthur (2 x)

Explanations from Description should be written between the examples.

(18) http://docs.witheve.com/handbook/string-interpolation/
eacother should be each other

(19)
http://docs.witheve.com/handbook/add/
then := will create should be then += will create

(20) http://docs.witheve.com/handbook/action-phase : page does not yet exist

(21) the link time on http://docs.witheve.com/handbook/datetime/ does not work

(22)

http://docs.witheve.com/handbook/math/
Arithemtic
Should be
Arithmetic

(23)
In Eve 0.2.2; Idem fix, tan

(24) http://docs.witheve.com/handbook/math/mod/
The example code does not have an output because of [#angle value]
Replace by value = 30 for example.

(25) http://docs.witheve.com/handbook/math/range/
The { } notation is used for sets instead of ( )
y = {1, 3, 5, 6, 9} should be y = (1, 3, 5, 7, 9)

(26) http://docs.witheve.com/handbook/statistics/count/
he pervious example

(27) http://docs.witheve.com/handbook/statistics/random/
First example for random does not display anything, should be replaced by something like:

search
[#time minutes seconds]
x = random[seed: seconds]

commit @browser
[#div text: "{{minutes}} {{seconds}} - random: {{x}}"]

2nd example: should be: bind @browser
Same for 3rd example

(28) http://docs.witheve.com/handbook/strings/join/
takes tokens tokens together  redundant tokens
or should be: token tokens

(29)
// Join the tokens into a sentence again, with hyphens
search
[#token token index]
text = join[token, index, with: " "]
bind
[#div text] // Expected "the-quick-brown-fox"
 There is no definition for the function join

(30) http://docs.witheve.com/handbook/glossary/
Glosasry should be Glossary
Referential Transparentcy should be Referential Transparency

Thanks!

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions