Skip to content

Commit 0a55093

Browse files
authored
Merge pull request #1446 from ydah/fix_spelling
Fix typos
2 parents df03784 + 781db93 commit 0a55093

16 files changed

+37
-37
lines changed

docs/WhatsNew.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ methods are defined dynamically and not associated with any code.
9292
#### New `@!parse` directive to parse Ruby code
9393

9494
A new {tag:!parse} directive was added that allows a developer to have
95-
YARD parse code that might not necessarily be parseable in its original
95+
YARD parse code that might not necessarily be parsable in its original
9696
form. This is useful when using `instance_eval` and other dynamic
9797
meta-programming techniques to define methods or perform functionality.
9898
For instance, a common case of the "self.included" callback in module
@@ -1204,7 +1204,7 @@ that is actually being employed. Here's an example:
12041204
# @overload def to_html(html, autolink = true)
12051205
# This docstring describes the specific overload only.
12061206
# @param [String] html the HTML
1207-
# @param [Boolean] autolink whether or not to atuomatically link
1207+
# @param [Boolean] autolink whether or not to automatically link
12081208
# URL references
12091209
# @overload def to_html(html, opts = {})
12101210
# @param [String] html the HTML

lib/yard/cli/yardoc.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ def all_objects
334334
private
335335

336336
# Generates output for objects
337-
# @param [Hash, nil] checksums if supplied, a list of checkums for files.
337+
# @param [Hash, nil] checksums if supplied, a list of checksums for files.
338338
# @return [void]
339339
# @since 0.5.1
340340
def run_generate(checksums)

lib/yard/docstring_parser.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module YARD
88
#
99
# == Subclassing Notes
1010
#
11-
# The DocstringParser can be subclassed and subtituted during parsing by
11+
# The DocstringParser can be subclassed and substituted during parsing by
1212
# setting the {Docstring.default_parser} attribute with the name of the
1313
# subclass. This allows developers to change the way docstrings are
1414
# parsed, allowing for completely different docstring syntaxes.

lib/yard/handlers/ruby/attribute_handler.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class YARD::Handlers::Ruby::AttributeHandler < YARD::Handlers::Ruby::Base
5252
register(o)
5353
o.docstring = doc if o.docstring.blank?(false)
5454

55-
# Regsiter the object explicitly
55+
# Register the object explicitly
5656
namespace.attributes[scope][name][type] = o
5757
else
5858
obj = namespace.children.find {|other| other.name == meth.to_sym && other.scope == scope }

lib/yard/handlers/ruby/legacy/attribute_handler.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ class YARD::Handlers::Ruby::Legacy::AttributeHandler < YARD::Handlers::Ruby::Leg
5151
register(o)
5252
o.docstring = doc if o.docstring.blank?(false)
5353

54-
# Regsiter the object explicitly
54+
# Register the object explicitly
5555
namespace.attributes[scope][name][type] = o
5656
else
5757
obj = namespace.children.find {|other| other.name == meth.to_sym && other.scope == scope }

lib/yard/i18n/locale.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def load(locale_directory)
5757
end
5858

5959
# @param [String] message the translation target message.
60-
# @return [String] translated message. If tarnslation isn't
60+
# @return [String] translated message. If translation isn't
6161
# registered, the +message+ is returned.
6262
def translate(message)
6363
@messages[message] || message

lib/yard/i18n/message.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module I18n
88
#
99
# @since 0.8.1
1010
class Message
11-
# @return [String] the message ID of the trnslation target message.
11+
# @return [String] the message ID of the translation target message.
1212
attr_reader :id
1313

1414
# @return [Set] the set of locations. Location is an array of
@@ -18,7 +18,7 @@ class Message
1818
# @return [Set] the set of comments for the messages.
1919
attr_reader :comments
2020

21-
# Creates a trasnlate target message for message ID +id+.
21+
# Creates a translate target message for message ID +id+.
2222
#
2323
# @param [String] id the message ID of the translate target message.
2424
def initialize(id)

lib/yard/i18n/messages.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def [](id)
2828
@messages[id]
2929
end
3030

31-
# Registers a {Message}, the mssage ID of which is +id+. If
31+
# Registers a {Message}, the message ID of which is +id+. If
3232
# corresponding +Message+ is already registered, the previously
3333
# registered object is returned.
3434
#

lib/yard/i18n/pot_generator.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ def parse_files(files)
113113
#
114114
# Locations of the +Message+ are used to generate the reference
115115
# line that is started with "#: ". +relative_base_path+ passed
116-
# when the generater is created is prepended to each path in location.
116+
# when the generator is created is prepended to each path in location.
117117
#
118118
# Comments of the +Message+ are used to generate the
119119
# translator-comment line that is started with "# ".

lib/yard/options.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ def [](key) send(key) end
9494
#
9595
# @example Setting an option with Hash syntax
9696
# options[:format] = :html # equivalent to: options.format = :html
97-
# @param [Symbol, String] key the optin to set
97+
# @param [Symbol, String] key the option to set
9898
# @param [Object] value the value to set for the option
9999
# @return [Object] the value being set
100100
def []=(key, value) send("#{key}=", value) end

lib/yard/server/commands/base.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ def call(request)
119119
# def run
120120
# self.body = 'ERROR! The System is down!'
121121
# self.status = 500
122-
# self.headers['Conten-Type'] = 'text/plain'
122+
# self.headers['Content-Type'] = 'text/plain'
123123
# end
124124
# end
125125
#

lib/yard/tags/tag.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ def type
5858
end
5959

6060
# Provides a plain English summary of the type specification, or nil
61-
# if no types are provided or parseable.
61+
# if no types are provided or parsable.
6262
#
6363
# @return [String] a plain English description of the associated types
64-
# @return [nil] if no types are provided or not parseable
64+
# @return [nil] if no types are provided or not parsable
6565
def explain_types
6666
return nil if !types || types.empty?
6767
TypesExplainer.explain(*types)

lib/yard/tags/types_explainer.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def self.explain(*types)
1313
end
1414

1515
# (see explain)
16-
# @raise [SyntaxError] if the types are not parseable
16+
# @raise [SyntaxError] if the types are not parsable
1717
def self.explain!(*types)
1818
Parser.parse(types.join(", ")).join("; ")
1919
end

po/ja.po

+19-19
Original file line numberDiff line numberDiff line change
@@ -1501,7 +1501,7 @@ msgstr ""
15011501
"これらのオブジェクトはツリー構造のように振る舞い、これらの直接の子全てのリストを維持している。\n"
15021502
"namespaceではない全てのオブジェクトは単純にベースクラスのサブクラスである。\n"
15031503
"{YARD::CodeObjects::RootObject RootObject} は\n"
1504-
"特別な `NamespaceObject` ともいえ、Rubyの中のトップレベルnamaspaceを参照する。\n"
1504+
"特別な `NamespaceObject` ともいえ、Rubyの中のトップレベルnamespaceを参照する。\n"
15051505
"パラメータとして namespace オブジェクトを受け入れるメソッドは、\n"
15061506
"root オブジェクト用のショートカットとして `:root` シンボルも受け入れる。"
15071507

@@ -6175,7 +6175,7 @@ msgstr ""
61756175
"'default/class'から自動的に継承する。\n"
61766176
"そして 'default/class/setup.rb' の中に定義されるもの全ては、\n"
61776177
"'default/class/html/setup.rb' によって上書きされることも意味する。\n"
6178-
"(yard/lib以下の話ではなくyard/templetes以下の話)"
6178+
"(yard/lib以下の話ではなくyard/templates以下の話)"
61796179

61806180
#: ../docs/Templates.md:200
61816181
msgid ""
@@ -7124,7 +7124,7 @@ msgstr "#### Rubyのコードを解析する為の新しい `@!parse` ディレ
71247124
#: ../docs/WhatsNew.md:87
71257125
msgid ""
71267126
"A new {tag:!parse} directive was added that allows a developer to have\n"
7127-
"YARD parse code that might not necessarily be parseable in its original\n"
7127+
"YARD parse code that might not necessarily be parsable in its original\n"
71287128
"form. This is useful when using `instance_eval` and other dynamic\n"
71297129
"meta-programming techniques to define methods or perform functionality.\n"
71307130
"For instance, a common case of the \"self.included\" callback in module\n"
@@ -9452,7 +9452,7 @@ msgid ""
94529452
msgstr ""
94539453
"1. **新しいテンプレートエンジンとテンプレート**\n"
94549454
"2. **yardoc `--query` 引数**\n"
9455-
"3. **Greatly ecpanded API ドキュメント**\n"
9455+
"3. **Greatly expanded API ドキュメント**\n"
94569456
"4. **新しいプラグインのサポート**\n"
94579457
"5. **新しいタグ(@abstract, @private)**\n"
94589458
"6. **デフォルトのrake taskは`rake yard`コマンドになった**"
@@ -9607,7 +9607,7 @@ msgid ""
96079607
"This tag exists so that you can create a query (`--query !@private`) to\n"
96089608
"ignore all of these private objects in your documentation. You can also\n"
96099609
"use the new `--no-private` switch, which is a shortcut to the "
9610-
"afformentioned\n"
9610+
"aforementioned\n"
96119611
"query. You can read more about the new tags in the {file:docs/GettingStarted."
96129612
"md}\n"
96139613
"guide."
@@ -9816,7 +9816,7 @@ msgid ""
98169816
" # @overload def to_html(html, autolink = true)\n"
98179817
" # This docstring describes the specific overload only.\n"
98189818
" # @param [String] html the HTML\n"
9819-
" # @param [Boolean] autolink whether or not to atuomatically link\n"
9819+
" # @param [Boolean] autolink whether or not to automatically link\n"
98209820
" # URL references\n"
98219821
" # @overload def to_html(html, opts = {})\n"
98229822
" # @param [String] html the HTML\n"
@@ -9828,7 +9828,7 @@ msgstr ""
98289828
" # @overload def to_html(html, autolink = true)\n"
98299829
" # This docstring describes the specific overload only.\n"
98309830
" # @param [String] html the HTML\n"
9831-
" # @param [Boolean] autolink whether or not to atuomatically link\n"
9831+
" # @param [Boolean] autolink whether or not to automatically link\n"
98329832
" # URL references\n"
98339833
" # @overload def to_html(html, opts = {})\n"
98349834
" # @param [String] html the HTML\n"
@@ -11513,7 +11513,7 @@ msgstr ""
1151311513

1151411514
# @param [Hash, nil] checksums
1151511515
#: ../lib/yard/cli/yardoc.rb:340
11516-
msgid "if supplied, a list of checkums for files."
11516+
msgid "if supplied, a list of checksums for files."
1151711517
msgstr "提供する場合は、ファイルの為のチェックサムのリスト"
1151811518

1151911519
# @param [Hash, nil]
@@ -15746,7 +15746,7 @@ msgstr ""
1574615746
# YARD::DocstringParser
1574715747
#: ../lib/yard/docstring_parser.rb:11
1574815748
msgid ""
15749-
"The DocstringParser can be subclassed and subtituted during parsing by\n"
15749+
"The DocstringParser can be subclassed and substituted during parsing by\n"
1575015750
"setting the {Docstring.default_parser} attribute with the name of the\n"
1575115751
"subclass. This allows developers to change the way docstrings are\n"
1575215752
"parsed, allowing for completely different docstring syntaxes."
@@ -18512,7 +18512,7 @@ msgstr "翻訳目標のメッセージ"
1851218512
# @return [String]
1851318513
#: ../lib/yard/i18n/locale.rb:45
1851418514
msgid ""
18515-
"translated message. If tarnslation isn't\n"
18515+
"translated message. If translation isn't\n"
1851618516
"registered, the +message+ is returned."
1851718517
msgstr ""
1851818518

@@ -18525,7 +18525,7 @@ msgstr ""
1852518525

1852618526
# @param tag_name
1852718527
#: ../lib/yard/i18n/message.rb:11
18528-
msgid "the message ID of the trnslation target message."
18528+
msgid "the message ID of the translation target message."
1852918529
msgstr "翻訳目標のメッセージのメッセージID"
1853018530

1853118531
# @param [Fixnum, nil] line
@@ -18545,7 +18545,7 @@ msgstr "メッセージ用のコメントのグループ"
1854518545

1854618546
# YARD::Handlers::Processor#initialize
1854718547
#: ../lib/yard/i18n/message.rb:21
18548-
msgid "Creates a trasnlate target message for message ID +id+."
18548+
msgid "Creates a translate target message for message ID +id+."
1854918549
msgstr "メッセージID +id+ 用の翻訳目標のメッセージを作成する"
1855018550

1855118551
# @return [Tag]
@@ -18652,7 +18652,7 @@ msgstr ""
1865218652
# YARD::I18n::Messages#register
1865318653
#: ../lib/yard/i18n/messages.rb:31
1865418654
msgid ""
18655-
"Registers a {Message}, the mssage ID of which is +id+. If\n"
18655+
"Registers a {Message}, the message ID of which is +id+. If\n"
1865618656
"corresponding +Message+ is already registered, the previously\n"
1865718657
"registered object is returned."
1865818658
msgstr ""
@@ -18876,7 +18876,7 @@ msgstr ""
1887618876
msgid ""
1887718877
"Locations of the +Message+ are used to generate the reference\n"
1887818878
"line that is started with \"#: \". +relative_base_path+ passed\n"
18879-
"when the generater is created is prepended to each path in location."
18879+
"when the generator is created is prepended to each path in location."
1888018880
msgstr ""
1888118881

1888218882
# YARD::I18n::PotGenerator#generate
@@ -19475,7 +19475,7 @@ msgstr "tag|example|ハッシュ構文を用いたオプションの設定"
1947519475

1947619476
# @param [Hash] options
1947719477
#: ../lib/yard/options.rb:99
19478-
msgid "the optin to set"
19478+
msgid "the option to set"
1947919479
msgstr "設定するためのオプション"
1948019480

1948119481
# @param [Object] value
@@ -23736,7 +23736,7 @@ msgid ""
2373623736
" def run\n"
2373723737
" self.body = 'ERROR! The System is down!'\n"
2373823738
" self.status = 500\n"
23739-
" self.headers['Conten-Type'] = 'text/plain'\n"
23739+
" self.headers['Content-Type'] = 'text/plain'\n"
2374023740
" end\n"
2374123741
"end"
2374223742
msgstr ""
@@ -27892,7 +27892,7 @@ msgstr "任意のタイトルとして、リンクに表示する"
2789227892
#: ../lib/yard/templates/helpers/base_helper.rb:143
2789327893
#: ../lib/yard/templates/helpers/html_helper.rb:220
2789427894
msgid "Links to an extra file"
27895-
msgstr "extarファイルにリンクする"
27895+
msgstr "extraファイルにリンクする"
2789627896

2789727897
# @param [String] anchor
2789827898
#: ../lib/yard/templates/helpers/base_helper.rb:149
@@ -30096,7 +30096,7 @@ msgstr "解析された式"
3009630096
#~ "{Library.default_factory}."
3009730097
#~ msgstr ""
3009830098
#~ "次の事に留意する。\n"
30099-
#~ "+tag_facotory+ は、タグを解析する為に利用されるfactoryオブジェクトとな"
30099+
#~ "+tag_factory+ は、タグを解析する為に利用されるfactoryオブジェクトとな"
3010030100
#~ "る。\n"
3010130101
#~ "この値は{DefaultFactory}クラスがデフォルトとなり、\n"
3010230102
#~ "{Library.default_factory}を変更する事によって設定できる。"
@@ -31067,7 +31067,7 @@ msgstr "解析された式"
3106731067

3106831068
#~ msgid ""
3106931069
#~ "* **Domain Specific Language (DSL)**: In the context of Ruby, a DSL is a "
31070-
#~ "languge\n"
31070+
#~ "language\n"
3107131071
#~ " optimized for a specific domain (problem) but represented using Ruby "
3107231072
#~ "syntax."
3107331073
#~ msgstr ""

spec/handlers/dsl_handler_spec.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@
210210
eof
211211
end
212212

213-
it "warns on unparseable DSL statements" do
213+
it "warns on unparsable DSL statements" do
214214
undoc_error "private(*foo(bar))"
215215
end if HAVE_RIPPER
216216

spec/tags/library_spec.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def tag(docstring)
4141
expect(tag("@return").explain_types).to eq nil
4242
end
4343

44-
it "returns nil if types are not parseable" do
44+
it "returns nil if types are not parsable" do
4545
expect(tag("@return [$]").explain_types).to eq nil
4646
end
4747
end

0 commit comments

Comments
 (0)