diff options
author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-07-19 02:26:08 +0000 |
---|---|---|
committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-07-19 02:26:08 +0000 |
commit | b19a968f9ad54bc6a71bcb657271166931e59805 (patch) | |
tree | 506c738ebed98db70bf82d457b01ce48254e0279 /lib/rdoc | |
parent | 757dee1259ecb436debdb47f80905b73ed1ab510 (diff) | |
download | ruby-b19a968f9ad54bc6a71bcb657271166931e59805.tar.gz |
* 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
Diffstat (limited to 'lib/rdoc')
-rw-r--r-- | lib/rdoc/class_module.rb | 2 | ||||
-rw-r--r-- | lib/rdoc/markdown/literals_1_9.rb | 2 | ||||
-rw-r--r-- | lib/rdoc/markup.rb | 4 | ||||
-rw-r--r-- | lib/rdoc/markup/to_joined_paragraph.rb | 2 | ||||
-rw-r--r-- | lib/rdoc/markup/verbatim.rb | 2 | ||||
-rw-r--r-- | lib/rdoc/method_attr.rb | 2 | ||||
-rw-r--r-- | lib/rdoc/parser/c.rb | 6 | ||||
-rw-r--r-- | lib/rdoc/parser/ruby.rb | 4 | ||||
-rw-r--r-- | lib/rdoc/ri/paths.rb | 12 | ||||
-rw-r--r-- | lib/rdoc/tom_doc.rb | 2 | ||||
-rw-r--r-- | lib/rdoc/top_level.rb | 2 |
11 files changed, 20 insertions, 20 deletions
diff --git a/lib/rdoc/class_module.rb b/lib/rdoc/class_module.rb index 5a279b516d..b796050431 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 5aa90c65a2..3d1cf02e55 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 bdd2064d6f..0b6e187d97 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 6982d86697..835841071d 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 3886bbe8a5..0ddde675e3 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 5021929ea0..c9c377f671 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 968ca3c789..9f8d7ac020 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 bfddd53270..6e3e834c24 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 d7ea285eaa..970cb91461 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 3a5a098ae8..4cee0ce182 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 64e12d9ff9..b9d2021f99 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 |