summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-07-19 02:26:08 +0000
committerzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-07-19 02:26:08 +0000
commitb19a968f9ad54bc6a71bcb657271166931e59805 (patch)
tree506c738ebed98db70bf82d457b01ce48254e0279
parent757dee1259ecb436debdb47f80905b73ed1ab510 (diff)
* lib/rdoc/*: [DOC] Capitalize "Ruby" in documentation
Patch by Dave Worth https://github.com/ruby/ruby/pull/341 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42053 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--ChangeLog5
-rw-r--r--lib/rdoc/class_module.rb2
-rw-r--r--lib/rdoc/markdown/literals_1_9.rb2
-rw-r--r--lib/rdoc/markup.rb4
-rw-r--r--lib/rdoc/markup/to_joined_paragraph.rb2
-rw-r--r--lib/rdoc/markup/verbatim.rb2
-rw-r--r--lib/rdoc/method_attr.rb2
-rw-r--r--lib/rdoc/parser/c.rb6
-rw-r--r--lib/rdoc/parser/ruby.rb4
-rw-r--r--lib/rdoc/ri/paths.rb12
-rw-r--r--lib/rdoc/tom_doc.rb2
-rw-r--r--lib/rdoc/top_level.rb2
12 files changed, 25 insertions, 20 deletions
diff --git a/ChangeLog b/ChangeLog
index ee4e8dfcc9e..e5b86a30bd8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Fri Jul 19 11:25:12 2013 Zachary Scott <e@zzak.io>
+
+ * lib/rdoc/*: [DOC] Capitalize "Ruby" in documentation
+ Patch by Dave Worth https://github.com/ruby/ruby/pull/341
+
Fri Jul 19 11:23:55 2013 Zachary Scott <e@zzak.io>
* lib/rubygems*: [DOC] Capitalize "Ruby" in documentation
diff --git a/lib/rdoc/class_module.rb b/lib/rdoc/class_module.rb
index 5a279b516dd..b796050431b 100644
--- a/lib/rdoc/class_module.rb
+++ b/lib/rdoc/class_module.rb
@@ -175,7 +175,7 @@ class RDoc::ClassModule < RDoc::Context
alias direct_ancestors ancestors
##
- # Clears the comment. Used by the ruby parser.
+ # Clears the comment. Used by the Ruby parser.
def clear_comment
@comment = ''
diff --git a/lib/rdoc/markdown/literals_1_9.rb b/lib/rdoc/markdown/literals_1_9.rb
index 5aa90c65a28..3d1cf02e558 100644
--- a/lib/rdoc/markdown/literals_1_9.rb
+++ b/lib/rdoc/markdown/literals_1_9.rb
@@ -3,7 +3,7 @@
##
#--
-# This set of literals is for ruby 1.9 regular expressions and gives full
+# This set of literals is for Ruby 1.9 regular expressions and gives full
# unicode support.
#
# Unlike peg-markdown, this set of literals recognizes Unicode alphanumeric
diff --git a/lib/rdoc/markup.rb b/lib/rdoc/markup.rb
index bdd2064d6f6..0b6e187d974 100644
--- a/lib/rdoc/markup.rb
+++ b/lib/rdoc/markup.rb
@@ -127,7 +127,7 @@
# left, so the amount of indentation of verbatim text is unimportant.
#
# For HTML output RDoc makes a small effort to determine if a verbatim section
-# contains ruby source code. If so, the verbatim block will be marked up as
+# contains Ruby source code. If so, the verbatim block will be marked up as
# HTML. Triggers include "def", "class", "module", "require", the "hash
# rocket"# (=>) or a block call with a parameter.
#
@@ -683,7 +683,7 @@
#
# [+:markup:+ _type_]
# Overrides the default markup type for this comment with the specified
-# markup type. For ruby files, if the first comment contains this directive
+# markup type. For Ruby files, if the first comment contains this directive
# it is applied automatically to all comments in the file.
#
# Unless you are converting between markup formats you should use a
diff --git a/lib/rdoc/markup/to_joined_paragraph.rb b/lib/rdoc/markup/to_joined_paragraph.rb
index 6982d866978..835841071d3 100644
--- a/lib/rdoc/markup/to_joined_paragraph.rb
+++ b/lib/rdoc/markup/to_joined_paragraph.rb
@@ -47,7 +47,7 @@ class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
end
end
- # TODO use Enumerable#chunk when ruby 1.8 support is dropped
+ # TODO use Enumerable#chunk when Ruby 1.8 support is dropped
#parts = paragraph.parts.chunk do |part|
# String === part
#end.map do |string, chunk|
diff --git a/lib/rdoc/markup/verbatim.rb b/lib/rdoc/markup/verbatim.rb
index 3886bbe8a55..0ddde675e3a 100644
--- a/lib/rdoc/markup/verbatim.rb
+++ b/lib/rdoc/markup/verbatim.rb
@@ -65,7 +65,7 @@ class RDoc::Markup::Verbatim < RDoc::Markup::Raw
end
##
- # Is this verbatim section ruby code?
+ # Is this verbatim section Ruby code?
def ruby?
@format ||= nil # TODO for older ri data, switch the tree to marshal_dump
diff --git a/lib/rdoc/method_attr.rb b/lib/rdoc/method_attr.rb
index 5021929ea00..c9c377f671e 100644
--- a/lib/rdoc/method_attr.rb
+++ b/lib/rdoc/method_attr.rb
@@ -211,7 +211,7 @@ class RDoc::MethodAttr < RDoc::CodeObject
end
##
- # Attempts to sanitize the content passed by the ruby parser:
+ # Attempts to sanitize the content passed by the Ruby parser:
# remove outer parentheses, etc.
def block_params=(value)
diff --git a/lib/rdoc/parser/c.rb b/lib/rdoc/parser/c.rb
index 968ca3c7893..9f8d7ac020a 100644
--- a/lib/rdoc/parser/c.rb
+++ b/lib/rdoc/parser/c.rb
@@ -123,7 +123,7 @@ class RDoc::Parser::C < RDoc::Parser
include RDoc::Text
##
- # Maps C variable names to names of ruby classes or modules
+ # Maps C variable names to names of Ruby classes or modules
attr_reader :classes
@@ -139,7 +139,7 @@ class RDoc::Parser::C < RDoc::Parser
attr_reader :enclosure_dependencies
##
- # Maps C variable names to names of ruby classes (and singleton classes)
+ # Maps C variable names to names of Ruby classes (and singleton classes)
attr_reader :known_classes
@@ -150,7 +150,7 @@ class RDoc::Parser::C < RDoc::Parser
attr_reader :missing_dependencies
##
- # Maps C variable names to names of ruby singleton classes
+ # Maps C variable names to names of Ruby singleton classes
attr_reader :singleton_classes
diff --git a/lib/rdoc/parser/ruby.rb b/lib/rdoc/parser/ruby.rb
index bfddd53270a..6e3e834c244 100644
--- a/lib/rdoc/parser/ruby.rb
+++ b/lib/rdoc/parser/ruby.rb
@@ -1393,7 +1393,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
end
##
- # The core of the ruby parser.
+ # The core of the Ruby parser.
def parse_statements(container, single = NORMAL, current_method = nil,
comment = new_comment(''))
@@ -1826,7 +1826,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
end
##
- # Scans this ruby file for ruby constructs
+ # Scans this Ruby file for Ruby constructs
def scan
reset
diff --git a/lib/rdoc/ri/paths.rb b/lib/rdoc/ri/paths.rb
index d7ea285eaa5..970cb91461e 100644
--- a/lib/rdoc/ri/paths.rb
+++ b/lib/rdoc/ri/paths.rb
@@ -162,9 +162,9 @@ module RDoc::RI::Paths
##
# The location of ri data installed into the site dir.
#
- # Historically this was available for documentation installed by ruby
+ # Historically this was available for documentation installed by Ruby
# libraries predating RubyGems. It is unlikely to contain any content for
- # modern ruby installations.
+ # modern Ruby installations.
def self.site_dir
File.join BASE, 'site'
@@ -173,11 +173,11 @@ module RDoc::RI::Paths
##
# The location of the built-in ri data.
#
- # This data is built automatically when `make` is run when ruby is
- # installed. If you did not install ruby by hand you may need to install
+ # This data is built automatically when `make` is run when Ruby is
+ # installed. If you did not install Ruby by hand you may need to install
# the documentation yourself. Please consult the documentation for your
- # package manager or ruby installer for details. You can also use the
- # rdoc-data gem to install system ri data for common versions of ruby.
+ # package manager or Ruby installer for details. You can also use the
+ # rdoc-data gem to install system ri data for common versions of Ruby.
def self.system_dir
File.join BASE, 'system'
diff --git a/lib/rdoc/tom_doc.rb b/lib/rdoc/tom_doc.rb
index 3a5a098ae81..4cee0ce1829 100644
--- a/lib/rdoc/tom_doc.rb
+++ b/lib/rdoc/tom_doc.rb
@@ -147,7 +147,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
end
# Internal: Builds a verbatim from the token stream. A verbatim in the
- # Examples section will be marked as in ruby format.
+ # Examples section will be marked as in Ruby format.
#
# margin - The indentation from the margin for lines that belong to this
# verbatim section.
diff --git a/lib/rdoc/top_level.rb b/lib/rdoc/top_level.rb
index 64e12d9ff90..b9d2021f99c 100644
--- a/lib/rdoc/top_level.rb
+++ b/lib/rdoc/top_level.rb
@@ -98,7 +98,7 @@ class RDoc::TopLevel < RDoc::Context
##
# Adds class or module +mod+. Used in the building phase
- # by the ruby parser.
+ # by the Ruby parser.
def add_to_classes_or_modules mod
@classes_or_modules << mod