Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Fixing documentation typos #393

Merged
merged 1 commit into from

2 participants

@daaain

I realised that I managed to put a typo in the single line of documentation I added in the last pull request... Got so embarrassed that I went through the entire class and fixed all typos to redeem myself :)

@netzpirat netzpirat merged commit c8b8b6b into guard:master
@netzpirat
Owner

That's really appreciated. Most of the README and the YARDOCs are written by non native English speakers.

@daaain

I'm also non-native, but with the benefit of having lived in London for the last 6 years :)

Will definitely send more pull requests if I spot anything else!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 18, 2013
  1. @daaain
This page is out of date. Refresh to see the latest.
Showing with 5 additions and 5 deletions.
  1. +5 −5 lib/guard/guard.rb
View
10 lib/guard/guard.rb
@@ -7,12 +7,12 @@ module Guard
# depending on user interaction and file modification.
#
# `run_on_changes` could be implemented to handle all the changes task case (additions,
- # modifications, removals) in once, or each task can be implemented separatly with a
+ # modifications, removals) in once, or each task can be implemented separately with a
# specific behavior.
#
# In each of these Guard task methods you have to implement some work when you want to
# support this kind of task. The return value of each Guard task method is not evaluated
- # by Guard, but I'll be passed to the "_end" hook for further evaluation. You can
+ # by Guard, but it'll be passed to the "_end" hook for further evaluation. You can
# throw `:task_has_failed` to indicate that your Guard plugin method was not successful,
# and successive Guard plugin tasks will be aborted when the group has set the `:halt_on_fail`
# option.
@@ -47,7 +47,7 @@ class Guard
attr_accessor :watchers, :options, :group
# Initializes a Guard plugin.
- # Don't do any work here, especially as Guards plugins get initialized even if they are not in an active group!
+ # Don't do any work here, especially as Guard plugins get initialized even if they are not in an active group!
#
# @param [Array<Guard::Watcher>] watchers the Guard plugin file watchers
# @param [Hash] options the custom Guard plugin options
@@ -68,7 +68,7 @@ def self.template(name)
File.read("#{ ::Guard.locate_guard(name) }/lib/guard/#{ name }/templates/Guardfile")
end
- # Initialize the Guard plugin. This will copy the Guardfile template inside the Guard plugin gem.
+ # Initialize the Guard plugin. This will copy the Guardfile template inside the Guard plugin Gem.
# The template Guardfile must be located within the Gem at `lib/guard/guard-name/templates/Guardfile`.
#
# @param [String] name the name of the Guard plugin
@@ -90,7 +90,7 @@ def self.init(name)
end
end
- # Call once when Guard starts. Please override initialize method to init stuff.
+ # Called once when Guard starts. Please override initialize method to init stuff.
#
# @raise [:task_has_failed] when start has failed
# @return [Object] the task result
Something went wrong with that request. Please try again.