Permalink
Browse files

Fixed various typos discovered by rdoc-spellcheck

  • Loading branch information...
1 parent effa79f commit 51820d53431f7ba5ccad1731bd00000900140524 @drbrain drbrain committed Apr 6, 2012
View
2 DEVELOPERS.rdoc
@@ -44,7 +44,7 @@ markup parser::
markup tree::
Each parsed comment has a markup tree that represents common markup items
- such as headings, paragraphs, lists orverbatim text sections for example
+ such as headings, paragraphs, lists or verbatim text sections for example
code or output.
A generator uses a formatters to walks the tree to create output. Some
View
22 History.rdoc
@@ -21,7 +21,7 @@
* Improved title for HTML output to include <code>--title</code> in the
title element.
* <code>rdoc --pipe</code> now understands <code>--markup</code>.
- * RDoc now supports irc-scheme hyperlinks. Issue #83 by trans.
+ * RDoc now supports IRC-scheme hyperlinks. Issue #83 by trans.
* Bug fixes
* Fixed title on HTML output for pages.
@@ -280,9 +280,9 @@
=== 3.5.3 / 2010-02-06
* Bug fixes
- * When including a file lossily force-transcode it to the output encoding
- instead of crashing to preserve as much content as possible. Ruby Bug
- #4376 by Yui NARUSE.
+ * When including a file perform a lossy force-transcoding to the output
+ encoding instead of crashing to preserve as much content as possible.
+ Ruby Bug #4376 by Yui NARUSE.
* Work around inconsistent encoding result from String#sub!, String#gsub!.
Related to Ruby Bug #4376.
* Work around inconsistent encoding result from String#[]=. Related to Ruby
@@ -619,7 +619,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
=== 2.5.4 / 2010-04-18
* 2 Minor Enhancements
- * Methods will now be cross-referenced when preceeded with ::. Ruby Bug
+ * Methods will now be cross-referenced when preceded with ::. Ruby Bug
#3169 by Marc-Andre Lafortune.
* Methods now have human readable fragment identifiers for HTML output.
(#method-i-gsub vs #M000005). Ruby Bug #3023 by Marc-Andre Lafortune.
@@ -707,7 +707,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
* Images are no longer executable. Bug #27156.
* --op is no longer overridden by --ri. Bug #27054.
* :method: now works when at the end of a class. Bug #26910.
- * Preserve elipsis from call-seq in Darkfish. Patch #26974.
+ * Preserve ellipsis from call-seq in Darkfish. Patch #26974.
* Emacs-style <tt>coding:</tt> is handled properly. Patch #27388.
* RDoc::RubyLex now parses UTF-8 identifiers. Bug #26946, #26947.
* Fixed namespace lookup rules. Bug #26161.
@@ -775,8 +775,8 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
* Added method list to index.html
* 6 Bug Fixes
- * nodoc'd classes no longer appear in the index. Bug #23751 by Clifford
- Heath.
+ * A class marked nodoc no longer appears in the index. Bug #23751 by
+ Clifford Heath.
* Fix 1.9 compatibility issues. Bug #23815 by paddor.
* Darkfish now respects --charset
* RDoc no longer attempts to be lazy when building HTML. This is a
@@ -809,7 +809,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
* Ignore nonexistent files instead of crashing
* .txt and .rdoc files are always considered text. Patch #22897 by Aaron
Patterson.
- * When merging ri data with a nonexistant directory, RDoc no longer crashes
+ * When merging ri data with a nonexistent directory, RDoc no longer crashes
* Fix visibility of methods in XML output. Issue by Yehuda Katz.
* Fixed relative link generation
* Fix crash, RDoc now ignores comments above local variable assignments in
@@ -901,7 +901,7 @@ documentation about ri.
* Fixed a case where RDoc first would encounter Foo::Bar and then would
encounter class Foo. Previously, RDoc erroneously would have considered
that both a Foo class and a Foo module existed.
- * Fix a clase where RDoc would not generate correct cross-reference links
+ * Fix a class where RDoc would not generate correct cross-reference links
to a class contained within a module of the same name (i.e. RDoc::RDoc)
* Prevented RDoc from trying to parse binary files, which would produce
garbage output.
@@ -953,7 +953,7 @@ documentation about ri.
* Sections work in the default template again
* Doesn't warn about :foo:: list item being an unrecognized directive
* RDoc no longer converts characters inside tt tags
- * Fixed "unitialized constant RDoc::Markup::ToHtml::HTML"
+ * Fixed "uninitialized constant RDoc::Markup::ToHtml::HTML"
* Fixed generation of relative links
* Fixed various diagram generation issues
* Fixed templates broken by switch to erb
View
2 README.rdoc
@@ -58,4 +58,4 @@ LICENSE.rdoc.
This software is provided "as is" and without any express or implied
warranties, including, without limitation, the implied warranties of
-merchantibility and fitness for a particular purpose.
+merchantability and fitness for a particular purpose.
View
1 Rakefile
@@ -142,4 +142,3 @@ task :diff_rubinius do
sh "diff #{diff_options} test #{rubinius_dir}/test/rdoc; true"
end
-
View
6 TODO.rdoc
@@ -5,15 +5,14 @@ Forward Looking Statements applies.
Blockers:
+* Update LICENSE to match ruby's switch
* The alias keyword should not be bidirectional
-* Github extensions to markdown
* Fix RDoc::Parser#use_markup to handle the filename (see TODO)
* Restore backwards compatibility due to paragraph text joining from existing
ri files
Nice to have:
-* Update LICENSE to match ruby's switch
* Reload the RDoc tree from an RI store
* Re-run generators
* Parse only changed files (like in ruby)
@@ -27,12 +26,14 @@ Nice to have:
* Global variable support
* Page support for ri
* Provide the code_object to directive handlers
+* Add RDoc::Constant#full_name
=== 4
API changes to RDoc
* Remove global state
+ * Use top_levels argument for generators
* Remove RDoc::RDocError
* RDoc::TopLevel#add_method should automatically create the appropriate method
class rather than requiring one be passed in.
@@ -43,6 +44,7 @@ API changes to RDoc
* Rename Context to Container
* Rename NormalClass to Class
* Add versions to RDoc::Markup syntax tree marshal format
+* Comments can no longer be Strings
=== Crazy Ideas
View
4 lib/rdoc/code_object.rb
@@ -214,7 +214,7 @@ def file_name
##
# Force the documentation of this object unless documentation
- # has been turned off by :endoc:
+ # has been turned off by :enddoc:
#--
# HACK untested, was assigning to an ivar
@@ -283,7 +283,7 @@ def record_location top_level
##
# Enable capture of documentation unless documentation has been
- # turned off by :endoc:
+ # turned off by :enddoc:
def start_doc
return if @done_documenting
View
4 lib/rdoc/context.rb
@@ -1079,8 +1079,8 @@ def set_visibility_for(methods, visibility, singleton = false)
end
##
- # Sorts sections alphabetically (default) or in TomDoc fasion (none, Public,
- # Internal, Deprecated)
+ # Sorts sections alphabetically (default) or in TomDoc fashion (none,
+ # Public, Internal, Deprecated)
def sort_sections
titles = @sections.map { |title, _| title }
View
3 lib/rdoc/generator/markup.rb
@@ -1,4 +1,3 @@
-
##
# Handle common RDoc::Markup tasks for various CodeObjects
#
@@ -47,7 +46,7 @@ def formatter
##
# Build a webcvs URL starting for the given +url+ with +full_path+ appended
# as the destination path. If +url+ contains '%s' +full_path+ will be
- # sprintf'd into +url+ instead.
+ # will replace the %s using sprintf on the +url+.
def cvs_url(url, full_path)
if /%s/ =~ url then
View
2 lib/rdoc/markup.rb
@@ -63,7 +63,7 @@
#
# puts h.convert(input_string)
#
-# You can extend the RDoc::Markup parser to recognise new markup
+# You can extend the RDoc::Markup parser to recognize new markup
# sequences, and to add special processing for text that matches a
# regular expression. Here we make WikiWords significant to the parser,
# and also make the sequences {word} and \<no>text...</no> signify
View
2 lib/rdoc/markup/formatter_test_case.rb
@@ -679,7 +679,7 @@ def test_accept_list_end_note
end
##
- # Calls accept_list_end_ulpha
+ # Calls accept_list_end_ualpha
def test_accept_list_end_ualpha
@to.start_accepting
View
2 lib/rdoc/markup/to_table_of_contents.rb
@@ -7,7 +7,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
@to_toc = nil
##
- # Singleton for ToC generation
+ # Singleton for table-of-contents generation
def self.to_toc
@to_toc ||= new
View
8 lib/rdoc/method_attr.rb
@@ -171,10 +171,10 @@ def find_method_or_attribute name # :nodoc:
# Abstract method. Contexts in their building phase call this
# to register a new alias for this known method/attribute.
#
- # - creates a new AnyMethod/Attribute +newa+ named an_alias.new_name;
- # - adds +self+ as +newa.is_alias_for+;
- # - adds +newa+ to #aliases
- # - adds +newa+ to the methods/attributes of +context+.
+ # - creates a new AnyMethod/Attribute named <tt>an_alias.new_name</tt>;
+ # - adds +self+ as an alias for the new method or attribute
+ # - adds the method or attribute to #aliases
+ # - adds the method or attribute to +context+.
def add_alias(an_alias, context)
raise NotImplementedError
View
2 lib/rdoc/options.rb
@@ -165,7 +165,7 @@ class RDoc::Options
attr_accessor :formatter
##
- # Description of the output generator (set with the <tt>--fmt</tt> option)
+ # Description of the output generator (set with the <tt>--format</tt> option)
attr_accessor :generator
View
4 lib/rdoc/parser/ruby.rb
@@ -94,7 +94,7 @@
# You can force the name of a method using the :method: directive:
#
# ##
-# # :method: woo_hoo!
+# # :method: some_method!
#
# By default, meta-methods are instance methods. To indicate that a method is
# a singleton method instead use the :singleton-method: directive:
@@ -105,7 +105,7 @@
# You can also use the :singleton-method: directive with a name:
#
# ##
-# # :singleton-method: woo_hoo!
+# # :singleton-method: some_method!
#
# Additionally you can mark a method as an attribute by
# using :attr:, :attr_reader:, :attr_writer: or :attr_accessor:. Just like
View
4 lib/rdoc/ri/driver.rb
@@ -597,7 +597,7 @@ def classes
end
##
- # Returns the stores wherin +name+ is found along with the classes and
+ # Returns the stores wherein +name+ is found along with the classes and
# includes that match it
def classes_and_includes_for name
@@ -1008,7 +1008,7 @@ def load_methods_matching name
end
##
- # Builds a RDoc::Markup::Document from +found+, +klasess+ and +includes+
+ # Builds a RDoc::Markup::Document from +found+, +klasses+ and +includes+
def method_document name, filtered
out = RDoc::Markup::Document.new
View
3 lib/rdoc/task.rb
@@ -128,7 +128,8 @@ class RDoc::Task < Rake::TaskLib
attr_accessor :template
##
- # Name of format generator (--fmt) used by rdoc. (defaults to rdoc's default)
+ # Name of format generator (<tt>--format<tt>) used by rdoc. (defaults to
+ # rdoc's default)
attr_accessor :generator

0 comments on commit 51820d5

Please sign in to comment.