1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* 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
This commit is contained in:
zzak 2013-07-19 02:26:08 +00:00
parent 757dee1259
commit b19a968f9a
12 changed files with 25 additions and 20 deletions

View file

@ -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

View file

@ -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 = ''

View file

@ -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

View file

@ -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

View file

@ -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|

View file

@ -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

View file

@ -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)

View file

@ -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

View file

@ -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

View file

@ -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'

View file

@ -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.

View file

@ -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