Permalink
Browse files

Merge branch 'fix_typo' of git://github.com/yuutayamada/yard

  • Loading branch information...
2 parents 6c7a7b3 + 817747d commit 797c0c9029e54355e58609266407c9627bf726d9 @lsegal committed Jul 9, 2012
Showing with 24 additions and 24 deletions.
  1. +21 −21 docs/Templates.md
  2. +2 −2 docs/WhatsNew.md
  3. +1 −1 lib/yard/i18n/message.rb
View
@@ -138,7 +138,7 @@ Every template should have at least one `setup.rb` file that defines the
{YARD::Templates::Template#init #init} method to set the
{YARD::Templates::Template#sections #sections} used by the template. If
a setup.rb is not defined in the template itself, there should be a template
-that is inherited (via parent directory or explcitly) that sets the sections
+that is inherited (via parent directory or explicitly) that sets the sections
on a newly created template.
A standard setup.rb file looks like:
@@ -347,33 +347,33 @@ field menus) generated from the base `layout` template:
1. Define your own custom stylesheet and/or javascript file
(default/ is the default template name inside of the /template root directory):
- /template/default/:
- |-- fulldoc
- | |-- html
- | | |-- css
- | | | |-- custom.css
- | | |-- js
- | | | |-- custom.js
+ /template/default/:
+ |-- fulldoc
+ | |-- html
+ | | |-- css
+ | | | |-- custom.css
+ | | |-- js
+ | | | |-- custom.js
2. Create a `setup.rb` in the `layout` template directory and override the methods
`stylesheets` and `javascripts`. The path to the template would be:
- /template/default/:
- |-- layout
- | |-- html
- | | |-- setup.rb
+ /template/default/:
+ |-- layout
+ | |-- html
+ | | |-- setup.rb
- And the code would look like:
+ And the code would look like:
- def stylesheets
- # Load the existing stylesheets while appending the custom one
- super + %w(css/custom.css)
- end
+ def stylesheets
+ # Load the existing stylesheets while appending the custom one
+ super + %w(css/custom.css)
+ end
- def javascripts
- # Load the existing javascripts while appending the custom one
- super + %w(js/custom.js)
- end
+ def javascripts
+ # Load the existing javascripts while appending the custom one
+ super + %w(js/custom.js)
+ end
To load additional stylesheets and javascripts for the search menus loaded from
View
@@ -1048,14 +1048,14 @@ New tags (@abstract, @private)
Two new tags were added to the list of builtin meta-tags in YARD. `@abstract`
marks a class/module/method as abstract while `@private` marks an object
-as "private". The latter tag is unsed in situations where an object is public
+as "private". The latter tag is used in situations where an object is public
due to Ruby's own visibility limitations (constants, classes and modules
can never be private) but not actually part of your public API. You should
use this tag sparingly, as it is not meant to be an equivalent to RDoc's
`:nodoc:` tag. Remember, YARD recommends documenting private objects too.
This tag exists so that you can create a query (`--query !@private`) to
ignore all of these private objects in your documentation. You can also
-use the new `--no-private` switch, which is a shortcut to the afformentioned
+use the new `--no-private` switch, which is a shortcut to the aforementioned
query. You can read more about the new tags in the {file:docs/GettingStarted.md}
guide.
View
@@ -11,7 +11,7 @@ class Message
attr_reader :id
# @return [Set] the set of locations. Location is an array of
- # path and line number where the message is appered.
+ # path and line number where the message is appeared.
attr_reader :locations
# @return [Set] the set of comments for the messages.

0 comments on commit 797c0c9

Please sign in to comment.