diff --git a/docs/WhatsNew.md b/docs/WhatsNew.md index 4e00c82a5..8c6a7824d 100644 --- a/docs/WhatsNew.md +++ b/docs/WhatsNew.md @@ -92,7 +92,7 @@ methods are defined dynamically and not associated with any code. #### New `@!parse` directive to parse Ruby code A new {tag:!parse} directive was added that allows a developer to have -YARD parse code that might not necessarily be parseable in its original +YARD parse code that might not necessarily be parsable in its original form. This is useful when using `instance_eval` and other dynamic meta-programming techniques to define methods or perform functionality. 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: # @overload def to_html(html, autolink = true) # This docstring describes the specific overload only. # @param [String] html the HTML - # @param [Boolean] autolink whether or not to atuomatically link + # @param [Boolean] autolink whether or not to automatically link # URL references # @overload def to_html(html, opts = {}) # @param [String] html the HTML diff --git a/lib/yard/cli/yardoc.rb b/lib/yard/cli/yardoc.rb index 7325644f5..5e5ffad1f 100644 --- a/lib/yard/cli/yardoc.rb +++ b/lib/yard/cli/yardoc.rb @@ -334,7 +334,7 @@ def all_objects private # Generates output for objects - # @param [Hash, nil] checksums if supplied, a list of checkums for files. + # @param [Hash, nil] checksums if supplied, a list of checksums for files. # @return [void] # @since 0.5.1 def run_generate(checksums) diff --git a/lib/yard/docstring_parser.rb b/lib/yard/docstring_parser.rb index 7ce8b6eb3..40b9cb5ae 100644 --- a/lib/yard/docstring_parser.rb +++ b/lib/yard/docstring_parser.rb @@ -8,7 +8,7 @@ module YARD # # == Subclassing Notes # - # The DocstringParser can be subclassed and subtituted during parsing by + # The DocstringParser can be subclassed and substituted during parsing by # setting the {Docstring.default_parser} attribute with the name of the # subclass. This allows developers to change the way docstrings are # parsed, allowing for completely different docstring syntaxes. diff --git a/lib/yard/handlers/ruby/attribute_handler.rb b/lib/yard/handlers/ruby/attribute_handler.rb index fa39e1505..ae73d5a13 100644 --- a/lib/yard/handlers/ruby/attribute_handler.rb +++ b/lib/yard/handlers/ruby/attribute_handler.rb @@ -52,7 +52,7 @@ class YARD::Handlers::Ruby::AttributeHandler < YARD::Handlers::Ruby::Base register(o) o.docstring = doc if o.docstring.blank?(false) - # Regsiter the object explicitly + # Register the object explicitly namespace.attributes[scope][name][type] = o else obj = namespace.children.find {|other| other.name == meth.to_sym && other.scope == scope } diff --git a/lib/yard/handlers/ruby/legacy/attribute_handler.rb b/lib/yard/handlers/ruby/legacy/attribute_handler.rb index 74a7b9db5..bebeb28fa 100644 --- a/lib/yard/handlers/ruby/legacy/attribute_handler.rb +++ b/lib/yard/handlers/ruby/legacy/attribute_handler.rb @@ -51,7 +51,7 @@ class YARD::Handlers::Ruby::Legacy::AttributeHandler < YARD::Handlers::Ruby::Leg register(o) o.docstring = doc if o.docstring.blank?(false) - # Regsiter the object explicitly + # Register the object explicitly namespace.attributes[scope][name][type] = o else obj = namespace.children.find {|other| other.name == meth.to_sym && other.scope == scope } diff --git a/lib/yard/i18n/locale.rb b/lib/yard/i18n/locale.rb index 6a6cd5ced..a1d277702 100644 --- a/lib/yard/i18n/locale.rb +++ b/lib/yard/i18n/locale.rb @@ -57,7 +57,7 @@ def load(locale_directory) end # @param [String] message the translation target message. - # @return [String] translated message. If tarnslation isn't + # @return [String] translated message. If translation isn't # registered, the +message+ is returned. def translate(message) @messages[message] || message diff --git a/lib/yard/i18n/message.rb b/lib/yard/i18n/message.rb index fa811efa8..74cf16932 100644 --- a/lib/yard/i18n/message.rb +++ b/lib/yard/i18n/message.rb @@ -8,7 +8,7 @@ module I18n # # @since 0.8.1 class Message - # @return [String] the message ID of the trnslation target message. + # @return [String] the message ID of the translation target message. attr_reader :id # @return [Set] the set of locations. Location is an array of @@ -18,7 +18,7 @@ class Message # @return [Set] the set of comments for the messages. attr_reader :comments - # Creates a trasnlate target message for message ID +id+. + # Creates a translate target message for message ID +id+. # # @param [String] id the message ID of the translate target message. def initialize(id) diff --git a/lib/yard/i18n/messages.rb b/lib/yard/i18n/messages.rb index 7a5a455ca..2c2ec228e 100644 --- a/lib/yard/i18n/messages.rb +++ b/lib/yard/i18n/messages.rb @@ -28,7 +28,7 @@ def [](id) @messages[id] end - # Registers a {Message}, the mssage ID of which is +id+. If + # Registers a {Message}, the message ID of which is +id+. If # corresponding +Message+ is already registered, the previously # registered object is returned. # diff --git a/lib/yard/i18n/pot_generator.rb b/lib/yard/i18n/pot_generator.rb index 7a7d93be3..04fd14320 100644 --- a/lib/yard/i18n/pot_generator.rb +++ b/lib/yard/i18n/pot_generator.rb @@ -113,7 +113,7 @@ def parse_files(files) # # Locations of the +Message+ are used to generate the reference # line that is started with "#: ". +relative_base_path+ passed - # when the generater is created is prepended to each path in location. + # when the generator is created is prepended to each path in location. # # Comments of the +Message+ are used to generate the # translator-comment line that is started with "# ". diff --git a/lib/yard/options.rb b/lib/yard/options.rb index 0dc4eeeac..0b672d784 100644 --- a/lib/yard/options.rb +++ b/lib/yard/options.rb @@ -94,7 +94,7 @@ def [](key) send(key) end # # @example Setting an option with Hash syntax # options[:format] = :html # equivalent to: options.format = :html - # @param [Symbol, String] key the optin to set + # @param [Symbol, String] key the option to set # @param [Object] value the value to set for the option # @return [Object] the value being set def []=(key, value) send("#{key}=", value) end diff --git a/lib/yard/server/commands/base.rb b/lib/yard/server/commands/base.rb index 10e2320ae..ef9d83f3a 100644 --- a/lib/yard/server/commands/base.rb +++ b/lib/yard/server/commands/base.rb @@ -119,7 +119,7 @@ def call(request) # def run # self.body = 'ERROR! The System is down!' # self.status = 500 - # self.headers['Conten-Type'] = 'text/plain' + # self.headers['Content-Type'] = 'text/plain' # end # end # diff --git a/lib/yard/tags/tag.rb b/lib/yard/tags/tag.rb index 516b2910b..05513839b 100644 --- a/lib/yard/tags/tag.rb +++ b/lib/yard/tags/tag.rb @@ -58,10 +58,10 @@ def type end # Provides a plain English summary of the type specification, or nil - # if no types are provided or parseable. + # if no types are provided or parsable. # # @return [String] a plain English description of the associated types - # @return [nil] if no types are provided or not parseable + # @return [nil] if no types are provided or not parsable def explain_types return nil if !types || types.empty? TypesExplainer.explain(*types) diff --git a/lib/yard/tags/types_explainer.rb b/lib/yard/tags/types_explainer.rb index a72d1a703..d87657665 100644 --- a/lib/yard/tags/types_explainer.rb +++ b/lib/yard/tags/types_explainer.rb @@ -13,7 +13,7 @@ def self.explain(*types) end # (see explain) - # @raise [SyntaxError] if the types are not parseable + # @raise [SyntaxError] if the types are not parsable def self.explain!(*types) Parser.parse(types.join(", ")).join("; ") end diff --git a/po/ja.po b/po/ja.po index 199fb1486..ab5b5ff13 100644 --- a/po/ja.po +++ b/po/ja.po @@ -1501,7 +1501,7 @@ msgstr "" "これらのオブジェクトはツリー構造のように振る舞い、これらの直接の子全てのリストを維持している。\n" "namespaceではない全てのオブジェクトは単純にベースクラスのサブクラスである。\n" "{YARD::CodeObjects::RootObject RootObject} は\n" -"特別な `NamespaceObject` ともいえ、Rubyの中のトップレベルnamaspaceを参照する。\n" +"特別な `NamespaceObject` ともいえ、Rubyの中のトップレベルnamespaceを参照する。\n" "パラメータとして namespace オブジェクトを受け入れるメソッドは、\n" "root オブジェクト用のショートカットとして `:root` シンボルも受け入れる。" @@ -6175,7 +6175,7 @@ msgstr "" "'default/class'から自動的に継承する。\n" "そして 'default/class/setup.rb' の中に定義されるもの全ては、\n" "'default/class/html/setup.rb' によって上書きされることも意味する。\n" -"(yard/lib以下の話ではなくyard/templetes以下の話)" +"(yard/lib以下の話ではなくyard/templates以下の話)" #: ../docs/Templates.md:200 msgid "" @@ -7124,7 +7124,7 @@ msgstr "#### Rubyのコードを解析する為の新しい `@!parse` ディレ #: ../docs/WhatsNew.md:87 msgid "" "A new {tag:!parse} directive was added that allows a developer to have\n" -"YARD parse code that might not necessarily be parseable in its original\n" +"YARD parse code that might not necessarily be parsable in its original\n" "form. This is useful when using `instance_eval` and other dynamic\n" "meta-programming techniques to define methods or perform functionality.\n" "For instance, a common case of the \"self.included\" callback in module\n" @@ -9452,7 +9452,7 @@ msgid "" msgstr "" "1. **新しいテンプレートエンジンとテンプレート**\n" "2. **yardoc `--query` 引数**\n" -"3. **Greatly ecpanded API ドキュメント**\n" +"3. **Greatly expanded API ドキュメント**\n" "4. **新しいプラグインのサポート**\n" "5. **新しいタグ(@abstract, @private)**\n" "6. **デフォルトのrake taskは`rake yard`コマンドになった**" @@ -9607,7 +9607,7 @@ msgid "" "This tag exists so that you can create a query (`--query !@private`) to\n" "ignore all of these private objects in your documentation. You can also\n" "use the new `--no-private` switch, which is a shortcut to the " -"afformentioned\n" +"aforementioned\n" "query. You can read more about the new tags in the {file:docs/GettingStarted." "md}\n" "guide." @@ -9816,7 +9816,7 @@ msgid "" " # @overload def to_html(html, autolink = true)\n" " # This docstring describes the specific overload only.\n" " # @param [String] html the HTML\n" -" # @param [Boolean] autolink whether or not to atuomatically link\n" +" # @param [Boolean] autolink whether or not to automatically link\n" " # URL references\n" " # @overload def to_html(html, opts = {})\n" " # @param [String] html the HTML\n" @@ -9828,7 +9828,7 @@ msgstr "" " # @overload def to_html(html, autolink = true)\n" " # This docstring describes the specific overload only.\n" " # @param [String] html the HTML\n" -" # @param [Boolean] autolink whether or not to atuomatically link\n" +" # @param [Boolean] autolink whether or not to automatically link\n" " # URL references\n" " # @overload def to_html(html, opts = {})\n" " # @param [String] html the HTML\n" @@ -11513,7 +11513,7 @@ msgstr "" # @param [Hash, nil] checksums #: ../lib/yard/cli/yardoc.rb:340 -msgid "if supplied, a list of checkums for files." +msgid "if supplied, a list of checksums for files." msgstr "提供する場合は、ファイルの為のチェックサムのリスト" # @param [Hash, nil] @@ -15746,7 +15746,7 @@ msgstr "" # YARD::DocstringParser #: ../lib/yard/docstring_parser.rb:11 msgid "" -"The DocstringParser can be subclassed and subtituted during parsing by\n" +"The DocstringParser can be subclassed and substituted during parsing by\n" "setting the {Docstring.default_parser} attribute with the name of the\n" "subclass. This allows developers to change the way docstrings are\n" "parsed, allowing for completely different docstring syntaxes." @@ -18512,7 +18512,7 @@ msgstr "翻訳目標のメッセージ" # @return [String] #: ../lib/yard/i18n/locale.rb:45 msgid "" -"translated message. If tarnslation isn't\n" +"translated message. If translation isn't\n" "registered, the +message+ is returned." msgstr "" @@ -18525,7 +18525,7 @@ msgstr "" # @param tag_name #: ../lib/yard/i18n/message.rb:11 -msgid "the message ID of the trnslation target message." +msgid "the message ID of the translation target message." msgstr "翻訳目標のメッセージのメッセージID" # @param [Fixnum, nil] line @@ -18545,7 +18545,7 @@ msgstr "メッセージ用のコメントのグループ" # YARD::Handlers::Processor#initialize #: ../lib/yard/i18n/message.rb:21 -msgid "Creates a trasnlate target message for message ID +id+." +msgid "Creates a translate target message for message ID +id+." msgstr "メッセージID +id+ 用の翻訳目標のメッセージを作成する" # @return [Tag] @@ -18652,7 +18652,7 @@ msgstr "" # YARD::I18n::Messages#register #: ../lib/yard/i18n/messages.rb:31 msgid "" -"Registers a {Message}, the mssage ID of which is +id+. If\n" +"Registers a {Message}, the message ID of which is +id+. If\n" "corresponding +Message+ is already registered, the previously\n" "registered object is returned." msgstr "" @@ -18876,7 +18876,7 @@ msgstr "" msgid "" "Locations of the +Message+ are used to generate the reference\n" "line that is started with \"#: \". +relative_base_path+ passed\n" -"when the generater is created is prepended to each path in location." +"when the generator is created is prepended to each path in location." msgstr "" # YARD::I18n::PotGenerator#generate @@ -19475,7 +19475,7 @@ msgstr "tag|example|ハッシュ構文を用いたオプションの設定" # @param [Hash] options #: ../lib/yard/options.rb:99 -msgid "the optin to set" +msgid "the option to set" msgstr "設定するためのオプション" # @param [Object] value @@ -23736,7 +23736,7 @@ msgid "" " def run\n" " self.body = 'ERROR! The System is down!'\n" " self.status = 500\n" -" self.headers['Conten-Type'] = 'text/plain'\n" +" self.headers['Content-Type'] = 'text/plain'\n" " end\n" "end" msgstr "" @@ -27892,7 +27892,7 @@ msgstr "任意のタイトルとして、リンクに表示する" #: ../lib/yard/templates/helpers/base_helper.rb:143 #: ../lib/yard/templates/helpers/html_helper.rb:220 msgid "Links to an extra file" -msgstr "extarファイルにリンクする" +msgstr "extraファイルにリンクする" # @param [String] anchor #: ../lib/yard/templates/helpers/base_helper.rb:149 @@ -30096,7 +30096,7 @@ msgstr "解析された式" #~ "{Library.default_factory}." #~ msgstr "" #~ "次の事に留意する。\n" -#~ "+tag_facotory+ は、タグを解析する為に利用されるfactoryオブジェクトとな" +#~ "+tag_factory+ は、タグを解析する為に利用されるfactoryオブジェクトとな" #~ "る。\n" #~ "この値は{DefaultFactory}クラスがデフォルトとなり、\n" #~ "{Library.default_factory}を変更する事によって設定できる。" @@ -31067,7 +31067,7 @@ msgstr "解析された式" #~ msgid "" #~ "* **Domain Specific Language (DSL)**: In the context of Ruby, a DSL is a " -#~ "languge\n" +#~ "language\n" #~ " optimized for a specific domain (problem) but represented using Ruby " #~ "syntax." #~ msgstr "" diff --git a/spec/handlers/dsl_handler_spec.rb b/spec/handlers/dsl_handler_spec.rb index c46c989d7..4d98253c9 100644 --- a/spec/handlers/dsl_handler_spec.rb +++ b/spec/handlers/dsl_handler_spec.rb @@ -210,7 +210,7 @@ eof end - it "warns on unparseable DSL statements" do + it "warns on unparsable DSL statements" do undoc_error "private(*foo(bar))" end if HAVE_RIPPER diff --git a/spec/tags/library_spec.rb b/spec/tags/library_spec.rb index dc643fd86..36ed76e2a 100644 --- a/spec/tags/library_spec.rb +++ b/spec/tags/library_spec.rb @@ -41,7 +41,7 @@ def tag(docstring) expect(tag("@return").explain_types).to eq nil end - it "returns nil if types are not parseable" do + it "returns nil if types are not parsable" do expect(tag("@return [$]").explain_types).to eq nil end end