Skip to content

Commit e686306

Browse files
committed
Fix typos and improve clarity in various articles and the about page
1 parent e856aa8 commit e686306

8 files changed

Lines changed: 54 additions & 54 deletions

source/about.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@ All source code for TryRuby (this website) is available on
7070
### Contact
7171

7272
This website was created by Ivo Herweijer. I am a software developer and
73-
live The Netherlands. You can contact me via
73+
live in the Netherlands. You can contact me via
7474
<a href="https://github.com/ruby/TryRuby/issues" target="_blank">GitHub</a>.

source/articles/2015-01-01-try-ruby-version-4.html.markdown

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "TryRuby's history"
33
date: 2015/01/01
44
author: Ivo Herweijer
5-
the_summary: Some information about the history of TryRuby and the reasons for being of TryRuby<sup>R4</sup>.
5+
the_summary: Some information about the history of TryRuby and the reasons behind TryRuby<sup>R4</sup>.
66
---
77

88
## History
@@ -15,15 +15,15 @@ the lucky stiff', a.k.a. \_Why. You can read more about him on
1515
and David Miani. Next Eric Allam and Nick Walsh took over (Codeschool/EnvyLabs).
1616

1717
### Why_
18-
This fourth iteration of TryRuby was created for several reasons.
18+
This fourth iteration of TryRuby was created for several reasons.
1919

20-
- The lesson content was getting a bit dated. For instance the stuff about reading and writing
21-
disk files does not really belong in an entry level course these days. Writing blog software
22-
is also not very appealing anymore
20+
- The lesson content was getting a bit dated. For instance, material about reading and writing
21+
disk files does not really belong in an entry-level course these days. Writing blog software
22+
is also no longer very appealing
2323
- Lesson content also missed some important information (like __if__ statements)
2424
- All previous TryRuby versions consisted of an irb interpreter with a web front-end.
25-
Even though some security measures have been taken (isolating and restricting the irb process
26-
and whitelisting input), this still sounds like a bad idea from a security perspective!
25+
Even though some security measures were taken (isolating and restricting the irb process
26+
and whitelisting input), this still sounded like a bad idea from a security perspective!
2727
TryRuby<sup>R4</sup> runs inside the web browser
2828

2929
### Changes
@@ -32,25 +32,25 @@ I had to make some alterations to the TryRuby lesson content. Also updated some
3232

3333
- Opal uses immutable strings, so [ ] based string manipulation was replaced with gsub
3434
- File reading and writing removed and replaced by getting a json file from the internet
35-
- Since irb is not used anymore, it is possible (necessary) to run entire programs, not enter
35+
- Since irb is no longer used, it is possible (and necessary) to run entire programs, not enter
3636
commands line-by-line
3737
- Removed the pop-up stuff
3838
- Removed mousehole stuff
3939
- Improved the feedback given to the user based on the program's output a bit
4040
- Added support for lesson content in multiple languages. The Spanish, Brazilian Portuguese,
4141
Japanese, Russian, Ukrainian, Macedonian, Dutch, Turkish and French translations are available.
4242
__If YOU would like to add a translation to TryRuby you are most welcome !__
43-
- Added explanation of if/else statements
43+
- Added an explanation of if/else statements
4444
- Changed the subject of the "Class" tutorials from building a blog (so last decade) to making an
4545
instant messaging app called: Blurbalizer<sup>TM</sup>
4646
- Used markdown with frontmatter for editing lesson content
4747
- Used middleman as development environment
48-
- Added some articles with more background information for aspiring software developers
48+
- Added articles with more background information for aspiring software developers
4949

5050
### Next
51-
Where can TryRuby<sup>R4</sup> be improved ? Couple of things I've thought of.
51+
Where can TryRuby<sup>R4</sup> be improved? Here are a couple of things I've thought of.
5252
Your opinion is most welcome:
5353

5454
- Add some self evaluation questions at the end of each chapter
55-
- Maybe remove the lessons about classes. It's a bit advanced for an absolute beginners
55+
- Maybe remove the lessons about classes. It's a bit advanced for an absolute beginner
5656
course

source/articles/2015-01-02-testing.html.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Testing software is one of the most important aspects of software development. I
1010
you are writing is doing what it is supposed to do. Now and in the future.
1111

1212
Having a comprehensive set of tests for your code gives __you__ confidence that it does what it is
13-
supposed to do. It also helps bestow that confidence on __others__. Other people who are using or maintaining
13+
supposed to do. It also helps convey that confidence to __others__: people who use or maintain
1414
your code.
1515

1616
Running tests some time after you created your code, for instance after some components you rely on have been
1717
updated, will tell you if your code still works or you need to make changes.
1818

1919
### Different tests for different purposes
20-
There are a lot of different kinds of test. I've list a couple here, in order in which they are used in a
20+
There are many different kinds of tests. I've listed a few here, in the order they are commonly used in a
2121
real programming project:
2222

2323
- Unit tests
@@ -83,13 +83,13 @@ Here is an example from <a href="https://docs.cucumber.io/" target="_blank">Cucu
8383
> &nbsp;&nbsp;&nbsp;&nbsp;__When__ I try to post to "Expensive Therapy"
8484
> &nbsp;&nbsp;&nbsp;&nbsp;__Then__ I should see "Your article was published."
8585
86-
Each feature usually has many scenario's.
86+
Each feature usually has many scenarios.
8787

8888
### Test tools and automation
89-
Ruby has one of the most advanced set of testing tools available anywhere.
89+
Ruby has one of the most advanced sets of testing tools available.
9090

9191
For supporting TDD style testing both __rspec__ and __minitest__ are very popular.
92-
BDD style testing is often done with __cucumber__. Cucumber lets you translate functional
92+
BDD-style testing is often done with __cucumber__. Cucumber lets you translate functional
9393
requirements written in plain English into executable (!) tests for your Ruby code.
9494

9595
Testing is not supposed to involve additional work. This would soon lead to less testing.
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: "Is there an App for that ?"
2+
title: "Is there an App for that?"
33
date: 2015/01/03
44
author: Ivo Herweijer
55
the_summary: Is there an App for that, or how to deliver your fantastic new service to your customers.
66
---
77

8-
## Is there an App for that ?
8+
## Is there an App for that?
99

1010
This article is about how to deliver a service (aka your software) to your customers.
1111

@@ -14,7 +14,7 @@ Life used to be very simple for software developers. You made some code, copied
1414
sent it to a customer. Next came the internet, so you could distribute code via a download.
1515
Or the website itself became the product.
1616

17-
Then computers started to shrink to the size of tablets, smartphone and wristwatches, with small
17+
Then computers started to shrink to the size of tablets, smartphones, and wristwatches, with small
1818
touch operated screens, without a real keyboard and sometimes requiring your code to run on the
1919
device itself.
2020

@@ -24,35 +24,35 @@ a website usable from a variety of computers and devices, plus a native app for
2424
platforms (Android, iOS).
2525
A lot of different technologies to learn!
2626

27-
Life for software developers isn't that simple anymore. What are your options ?
27+
Life for software developers isn't that simple anymore. What are your options?
2828

2929
### HTML5
30-
The first route available to you is to only create a web based version of your service.
30+
The first route available to you is to create only a web-based version of your service.
3131
Web browsers are getting more powerful every year. Giving you better control over the look
3232
and feel of your website, regardless of the size or type of device used by your customer.
3333

3434
But your customer will still need constant internet access to use your service. Fortunately
3535
the web browser can help us here as well. HTML 5 enabled web browsers support something called
36-
local storage and service workers, which you can use to make the customer think he/she is still
36+
local storage and service workers, which you can use to make the customer feel like they are still
3737
connected to your service. When an internet connection becomes available again, you can sync changes.
38-
I am not saying that this is easy to do, far from it, but it's do-able.
38+
I am not saying this is easy to do, far from it, but it's doable.
3939

4040
One thing that can make life easier is to use <a href="http://opalrb.com/" target="_blank">Opal</a>.
41-
This means that you can run Ruby code in the webbrowser. Normally webbrowsers only run Javascript,
41+
This means that you can run Ruby code in the web browser. Normally web browsers only run Javascript,
4242
but Opal cleverly translates your Ruby code to Javascript. This saves you having to learn Javascript.
43-
It is also very handy to use the same language for both the front-end (webbrowser) and the back-end
43+
It is also very handy to use the same language for both the front-end (web browser) and the back-end
4444
(webserver with Rails for instance).
4545

4646
> TryRuby uses Ruby and Opal for everything.
4747
4848
### Native apps
4949
The other possible route is to go native. Create an app for every mobile platform that you want
50-
to support. Native apps give you ultimate control over the look and feel off your program.
50+
to support. Native apps give you ultimate control over the look and feel of your program.
5151
You will also have better access to the sensors built into the device (movement, position, ...).
5252

5353
Huge drawback to this approach is that every mobile platform uses a completely different development
5454
environment and programming language. You might need to learn about Java, Objective-C, Swift,
5555
C-Sharp and others.
5656

57-
But you are in luck ! There are cross-platform tools available where you create you app once and
57+
But you are in luck! There are cross-platform tools available where you create your app once and
5858
distribute it to multiple mobile platforms.

source/articles/2015-01-04-web-development.html.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ the_summary: One of the areas of software development where Ruby really shines i
99
One of the areas of software development where Ruby really shines is web development. From creating
1010
a simple website to a full cloud based webservice, it is all easily attainable.
1111

12-
### Ruby-on-rails
12+
### Ruby on Rails
1313
I should mention Ruby on Rails. You have been learning the Ruby language, how to speak it.
1414
But Rails is a very powerful and popular toolkit for building websites.
1515

16-
Ruby-on-rails, or RoR, consists of set of Ruby libraries. These libraries help you do things that
16+
Ruby on Rails, or RoR, consists of a set of Ruby libraries. These libraries help you do things that
1717
websites commonly need. Like routing an incoming request to the correct handler. Or interacting with
1818
the database. Or returning a fully rendered webpage.
1919

2020
RoR makes creating a website easy, __if__ you follow the RoR conventions. This also means that you
21-
do not have to setup a lot of complicated stuff in order to get RoR to work.
21+
do not have to set up a lot of complicated stuff in order to get RoR to work.
2222
RoR people call this principle _convention over configuration_.
2323

2424
One important convention is called: _Model-View-Controller_ (for purists it is a design pattern). It means that you should separate code
@@ -27,7 +27,7 @@ controller).
2727

2828
If you're interested in learning about Rails, I would
2929
<a href="http://rubyonrails.org/" target="_blank">head over there</a>
30-
right away. Start using your Ruby skills proper!
30+
right away. Start putting your Ruby skills to proper use!
3131

3232
### Other frameworks
3333
One disadvantage of RoR is that, because there are so many libraries and conventions, it takes

source/articles/2015-01-05-what-i-left-out.html.markdown

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: What I've left out
33
date: 2015/01/05
44
author: Ivo Herweijer
5-
the_summary: TryRuby is a Ruby course for beginners. Its not possible to tell you everything about Ruby in 15 minutes. Here is an overview of what I have left out.
5+
the_summary: TryRuby is a Ruby course for beginners. It's not possible to tell you everything about Ruby in 15 minutes. Here is an overview of what I have left out.
66
---
77

88

99
## What I've left out
1010

11-
TryRuby is a Ruby course for beginners. Its not possible to tell you everything about Ruby in
11+
TryRuby is a Ruby course for beginners. It's not possible to tell you everything about Ruby in
1212
30 minutes. Here is an overview of some of the things that I have left out.
1313

1414
### Comments
15-
To add text to your Ruby file, you can do so with comments. Comments can be used for
16-
documentation, explain parts of your code or anything else you'd like.
15+
To add text to your Ruby file, you can use comments. Comments can be used for
16+
documentation, to explain parts of your code, or anything else you'd like.
1717

1818
Single line comments
1919

@@ -71,20 +71,20 @@ And there is an alternate form:
7171
end
7272

7373
### Regular expressions
74-
Sometimes you have a string and you want to test if that string contains some text. For instance if
74+
Sometimes you have a string and you want to test whether it contains some text. For instance, whether
7575
'user\_123' starts with 'user\_'. You could use a test like __my_string[0..4] == 'user\_'__, but
7676
there is a much more elegant and flexible way to do this kind of string testing, called
7777
regular expressions.
7878

79-
Reason this isn't in TryRuby lessons is the fact that regular expressions have a syntax that is so
79+
The reason this isn't in the TryRuby lessons is that regular expressions have a syntax that is so
8080
strange at first, it might make your head explode. If you see a complex regular expression for the
8181
first time, it is like a monkey has been randomly bashing away on a keyboard.
8282

8383
The regex for the example mentioned above is relatively simple:
8484

8585
my_string.match( /^user_(\d+)/ )
8686

87-
This will return __nil__ if my_string didn't conform to the regex, or a matchdata object if it did.
87+
This will return __nil__ if my_string didn't conform to the regex, or a MatchData object if it did.
8888
In the last case it will also give you the 123 part as the matched data.
8989

9090
The Ruby <a href="http://www.ruby-doc.org/core/Regexp.html" target="_blank">documentation</a> has
@@ -100,8 +100,8 @@ Now you can handle the missing method as if it existed. For instance you might w
100100
a _sort\_by\_variable_ method. Where _variable_ is the name of one of your class variables.
101101

102102
### Inspection
103-
Ruby can give you a lot of information about objects when a program is running. What an object is and
104-
what methods it responds to.
103+
Ruby can give you a lot of information about objects when a program is running, including what an object is
104+
and what methods it responds to.
105105

106106
# Inspection
107107
s = 'abc'
@@ -110,9 +110,9 @@ what methods it responds to.
110110
puts s.respond_to?(:match)
111111

112112
### Error handling
113-
Reality is that all programs can run into errors. Errors that only raise their ugly heads when your
113+
The reality is that all programs can run into errors. Errors that only raise their ugly heads when your
114114
program is running. And even when your code is flawless. That just happens.
115-
You can let your program crash, but it is usually nicer if you let your program continue and politely tell
115+
You can let your program crash, but it is usually nicer to let your program continue and politely report
116116
that an error has occurred and it can't continue what it was doing.
117117
Ruby has a couple of facilities for this purpose:
118118

@@ -130,7 +130,7 @@ stupid).
130130
raise "Yo dude seriously ? You can't enter zero for a divisor" if divisor == 0
131131

132132
### IO
133-
You will often need to read or write diskfiles. That is easy in Ruby. For instance reading can be done with
133+
You will often need to read or write disk files. That is easy in Ruby. For instance, reading can be done with
134134
<a href="http://www.ruby-doc.org/core/IO.html#method-i-read" target="_blank">IO.Read</a>.
135135

136136
# Read a file
@@ -146,7 +146,7 @@ on whether the left hand side is smaller, equal to or bigger than the right hand
146146
'a' <=> 'b' => Returns -1
147147

148148
### Class inheritance
149-
When you are coding objects (classes) that model some real life situation, you will often encounter
149+
When you are coding objects (classes) that model some real-life situation, you will often encounter
150150
objects that are a subset of other objects. And there are many of such subsets.
151151
This is where class inheritance comes to the rescue.
152152

@@ -227,7 +227,7 @@ to give you a quick start to solve your coding problem. Gems are also very easy
227227

228228
### DRY
229229
Not really a (Ruby) technique, but more a concept, DRY stands for __D__on't __R__epeat __Y__ourself.
230-
Meaning: do not write te same piece of code twice.
230+
Meaning: do not write the same piece of code twice.
231231
When you are coding you will often find you need to write a bit of code that is the same as, or very similar
232232
to, something you wrote before. Stop writing new code right then !!!
233233
Instead find the existing similar code and extract it into a new method. Call the new method from the

source/articles/2015-01-06-what-to-do-next.html.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: What's next
2+
title: What's next?
33
date: 2015/01/06
44
author: Ivo Herweijer
5-
the_summary: So, you finished the TryRuby lessons. Are you hungry for more ? Here are some tips to let you continue on the path to Ruby enlightenment.
5+
the_summary: So, you finished the TryRuby lessons. Are you hungry for more? Here are some tips to help you continue on the path to Ruby enlightenment.
66
---
77

8-
## What's next ?
9-
So, you finished the TryRuby lessons. Are you hungry for more ?
8+
## What's next?
9+
So, you finished the TryRuby lessons. Are you hungry for more?
1010

1111
You can use the
1212
<a href="/playground">TryRuby Playground</a>
@@ -26,9 +26,9 @@ You can find websites with lots more ideas (and suggested solutions) for coding
2626
Maybe you can read a book on Ruby. I'm not giving any suggestions since I want to remain
2727
impartial.
2828

29-
Follow an online course, of which there are many. And many are also free.
29+
Follow an online course, of which there are many. Many are also free.
3030

31-
Regardless what you do, you will find the Ruby
31+
Regardless of what you do, you will find the Ruby
3232
<a href="http://www.ruby-doc.org/core/" target="_blank">documentation</a>
3333
an invaluable resource.
3434

source/index.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Learn to program in Ruby in 30 minutes
1010
</h1>
1111

1212
<div id="tryruby-content">
13-
<p>Ruby is a programming language from Japan which is revolutionizing software development.</p>
13+
<p>Ruby is a programming language from Japan that is revolutionizing software development.</p>
1414
<p>The beauty of Ruby is found in its balance between simplicity and power.</p>
1515
<p>You can type some Ruby code in the editor and use these buttons to navigate:</p>
1616

0 commit comments

Comments
 (0)