Permalink
Browse files

Simple spelling and phrasing changes

Signed-off-by: leriksen <leif.eriksen.au@gmail.com>
  • Loading branch information...
1 parent 1f31c4a commit 90b0b87558b6df8ff2817b93abd3a82ba6e4f5b7 @leriksen leriksen committed with Apr 6, 2011
Showing with 45 additions and 44 deletions.
  1. +11 −11 guide/beginner.pdc
  2. +10 −10 guide/community.pdc
  3. +7 −7 guide/convincing_the_boss.pdc
  4. +17 −16 guide/style.pdc
View
22 guide/beginner.pdc
@@ -1,9 +1,9 @@
% Felix's Node.js Beginners Guide
There is lots of information about node.js, but given the rapid pace at which it
-is developed, it can be difficult for beginners to find current and good
-information on how to get started. This guide aims at providing exactly that,
-while staying updated with the latest stable version of node.js.
+is developing, it can be difficult for beginners to find good, current
+information on how to get started. This guide aims to provide exactly that,
+whilst staying updated with the latest stable version of node.js.
This guide has been updated to reflect the latest changes in node 0.4.x, the
currently stable branch of node.js.
@@ -27,7 +27,7 @@ simple hello world http server.
First of all: You should run a *nix operating system in order to use node.js at
this point. Linux and OSX are recommended, but you should also be able to use
FreeBSD and cygwin (on windows). A full windows port of node.js is in the works,
-but not ready for public usage yet.
+but it is not yet ready for public usage.
The most common way to install node.js is to directly compile it from the
downloaded source code. There are also various packages available for different
@@ -117,8 +117,8 @@ $ node hello_http.js
The first thing you'll notice is that this program, unlike our first one,
doesn't exit right away. That's because a node program will always run until
-it's certain that there are no events to be possible. In this case the open http
-server is the source of events that keeps things going.
+it's certain that no further events are possible. In this case the open http
+server is the source of events that will keep things going.
Testing the server is as simple as opening a new browser tab, and navigating to
the following url: [http://localhost:8080/](http://localhost:8080/). As
@@ -220,11 +220,11 @@ non-core modules, such as 'mysql'?
var mysql = require('mysql');
~~~
-In this case node.js will look at every directory, beginning with the one of the
-current file, and check if there is a folder called 'node_modules'. If such a
-folder is found, node.js will look into this folder for a file called
-'mysql.js'. If no matching file is found and the directory root '/' is reached,
-node.js will give up and throw an exception.
+In this case node.js will walk up the directory tree, moving through each
+parent directory in turn, checking in each to see if there is a folder called
+'node_modules'. If such a folder is found, node.js will look into this folder
+for a file called 'mysql.js'. If no matching file is found and the directory
+root '/' is reached, node.js will give up and throw an exception.
At this point node.js also considers an additional, mutable list of alternative
include directories which are accessible through the `require.paths` array.
View
20 guide/community.pdc
@@ -1,7 +1,7 @@
% Felix's Node.js Community Guide
If you have just read the Beginner's Guide, and you are interested in becoming
-more involed with the node.js community, this guide is for you.
+more involved with the node.js community, this guide is for you.
## IRC
@@ -14,8 +14,8 @@ people in there these days.
If you have a question, just go ahead and ask it. Depending on who's awake and
paying attention, you often get great replies right away. Otherwise just stick
-around and wait for an hour or so. After that it's ok to ask your question again
-in case you think it went by unnoticed.
+around and wait for an hour or so. After that it's ok to ask your question
+again, in case you think it went by unnoticed.
Oh, and you should always try to find your answer on the web first, but you [know
that][lmgtfy], right?
@@ -64,7 +64,7 @@ questions right away, there are usually other people around who can help as
well.
Ryan is currently working for [Joyent][joyent], a company that provides great
-heroku-style [node.js hosting][nodehosting], and is the official coporate
+heroku-style [node.js hosting][nodehosting], and is the official corporate
sponsor for node.js.
[bdfl]: http://en.wikipedia.org/wiki/BDFL
@@ -120,7 +120,7 @@ node.js libraries.
Tim is the original author of [connect][connect], and has been contributing to
node.js since the early days. He currently works for HP (formerly Palm), and
-is also known for collaborative blog [howtonode.org][howtonode].
+is also known for the collaborative blog [howtonode.org][howtonode].
* IRC Nick: creationix
* Twitter: [@creationix](http://twitter.com/creationix)
@@ -151,8 +151,8 @@ providing file uploading & video encoding as a service called
### Mikeal Rogers
-Mikeal is the author of [request][request], and is also very active in the
-development of node.js as well as the community.
+Mikeal is the author of [request][request], and is very active in the
+development of node.js, as well as the community.
* IRC Nick: mikeal
* Twitter: [@mikeal](http://twitter.com/mikeal)
@@ -197,7 +197,7 @@ also running a node.js startup called [DocumentCloud][].
Jed is a japanese translator who moonlights as a JavaScript ninja. His node.js
framework [fab.js][fabjs] takes a radical new approach to structuring your JS
-code, and includes all kinds of suprising aspects, exceeding most people's
+code, and includes all kinds of surprising aspects, exceeding most people's
understanding of JavaScript by far.
* IRC Nick: jedschmidt
@@ -211,10 +211,10 @@ understanding of JavaScript by far.
### Marak Squires
Marak who goes by the alias Jim Bastard, is mostly known for pumping out
-douzands of node.js libraries per month, an ability only exceeded by his artful
+dozens of node.js libraries per month, an ability only exceeded by his artful
use of profanity and trolling people. Don't get upset if he rubs you the wrong
way, he's a nice guy, but you just shouldn't challenge him to a Monkey Island
-style sword duell.
+style sword duel.
* IRC Nick: jimbastard
* Twitter: [@maraksquires](http://twitter.com/maraksquires)
View
14 guide/convincing_the_boss.pdc
@@ -1,21 +1,21 @@
% Felix's Node.js Convincing the boss guide
Now that you're all hyped up about using node.js, it's time to convince your
-boss. Well, maybe. I had the pleasure of [consulting][consulting] for different
-businesses on whether node.js is the right technology, and sometimes the answer
-is simply no.
+boss. Well, maybe. I have had the pleasure of [consulting][consulting] for
+different businesses on whether node.js is the right technology, and sometimes
+the answer is simply no.
So this guide is my opinionated collection of advice for those of you that want
-to explore if node.js makes sense for their business, and if so, how to convince
-the management.
+to explore whether node.js makes sense for their business, and if so, how to
+convince the management.
[consulting]: http://debuggable.com/
## Bad Use Cases
### CPU heavy apps
-Even so I love node.js, there are several use cases where it simply doesn't make
+Even though I love node.js, there are several use cases where it simply doesn't make
sense. The most obvious such case is apps that are very heavy on CPU usage, and
very light on actual I/O. So if you're planning to write video encoding
software, artificial intelligence or similar CPU hungry software, please do not
@@ -127,7 +127,7 @@ career.
This means that you get a huge and diverse pool of people you can hire, and you
probably already have plenty of talent in your own company. So if you're working
-for a growing company, this is a strong argument favoring node.js.
+for a growing company, this is a strong argument favouring node.js.
@akavlie
akavlie added a line comment Apr 6, 2011

The original wasn't mistaken; "favoring" = American spelling while "favouring" is British.

@leriksen
leriksen added a line comment Apr 6, 2011

I did try to avoid most corrections of that nature, where I'm aware of the difference - Australian's tend to use British spelling by default

@felixge
Owner
felixge added a line comment Apr 9, 2011

Since you're Australian and did the corrections, it's only fair you get some native charm into it : ).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
[lingua franca]: http://en.wikipedia.org/wiki/Lingua_franca
View
33 guide/style.pdc
@@ -7,22 +7,22 @@ will allow you to create beautiful and consistent software.
This guide assumes that you are only targeting node.js. If your code also needs
to run in the browser or other environments, please ignore some of it.
-Please also note that node.js as well as various packages for it each have
-their slightly own styles. So if you're interested in contributing to those,
-play by their rules.
+Please also note that node.js, as well as various packages for it, have
+their own slightly different styles. So if you're interested in contributing
+to those, play by their rules.
## Tabs vs Spaces
-Let's start with the religious problems first. Our [benevolant dictator][ryah]
+Let's start with the religious problems first. Our [benevolent dictator][ryah]
has chosen 2 space indention for the node core, so you would do well to follow
-his orders.
+his choice.
[ryah]: community.html#ryan-dahl
## Semicolons
There are [rebellious forces][isaac] that try to steal your semicolons from
-you. But make no mistake, our traditional culture is still [well and
+you. But make no mistake, our traditional culture is still [well and truly
alive][hnsemicolons]. So follow the community, and use those semicolons!
[isaac]: community.html#isaac-schlueter
@@ -36,7 +36,8 @@ executing the currently open file with node.js will come in very handy. While
[BDFL][bdfl] and your grandpa will also approve.
I'm typing this document in Notes on my iPad, but that's because I'm on a beach
-in Thailand, your work environment may impact your choice of editors as well.
+in Thailand. It's likely that your own work environment will impact your choice
+of editor as well.
[vim]: http://www.vim.org/
[bdfl]: http://en.wikipedia.org/wiki/BDFL
@@ -45,8 +46,8 @@ in Thailand, your work environment may impact your choice of editors as well.
Just like you brush your teeth after every meal, you clean up any trailing
whitespace in your JavaScript files before committing. Otherwise the rotten
-smell of careless neglect will drive away any contributors or co-workers after a
-while.
+smell of careless neglect will eventually drive away contributors and/or
+co-workers.
## Line length
@@ -91,7 +92,7 @@ if (true)
}
~~~
-Also notice the usage of spaces before and after the condition statement.
+Also, notice the use of whitespace before and after the condition statement.
## Variable declarations
@@ -414,10 +415,10 @@ Crazy shit that you will probably never need. Stay away from it.
Do not use setters, they cause more problems for people who try to use your
software than they can solve.
-Feel free to use getters that are free of [side effects][sideffect], like
+Feel free to use getters that are free from [side effects][sideeffect], like
providing a length property for a collection class.
-[sideffect]: http://en.wikipedia.org/wiki/Side_effect_(computer_science)
+[sideeffect]: http://en.wikipedia.org/wiki/Side_effect_(computer_science)
## EventEmitters
@@ -435,13 +436,13 @@ class to emit events. This is basically a simple implementation of the
[Observer pattern]: http://en.wikipedia.org/wiki/Observer_pattern
However, I strongly recommend that you never listen to the events of your own
-class from within it. It's not natural for an object to observe itself. It often
-leads to undesirable exposure of internal implementation details, and makes
-your code more difficult to follow along.
+class from within it. It isn't natural for an object to observe itself. It often
+leads to undesirable exposure to implementation details, and makes your code
+more difficult to follow.
## Inheritance / Object oriented programming
-Inheritance and object oriented programming are a whole subject by themselves.
+Inheritance and object oriented programming are subjects by themselves.
If you're interested in following this popular programming model, please read my
[Object oriented programming guide][].

0 comments on commit 90b0b87

Please sign in to comment.