readme_yard 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a4b3f3775475b7a7cb62fec62eb5c95d9d6ef905fab18151636a9c546530b10
-  data.tar.gz: 46be49cca9501b608b435a018ebc36555d698bf1d35da2badb15b0acd3c67231
+  metadata.gz: 3d5cd63671c91ee41af8ce37e33ae8a2cb1e2b71a70c2a9c6b5063128a635fce
+  data.tar.gz: 910ee77105320c38974f621d750719b43c33f3b2f2dadd7ec66a16b616303f28
 SHA512:
-  metadata.gz: '02608e395de5ca70c7936804a72f37a174594dd4604646f86880f67ea59a93ea56b8bbbfcd9e8de8178650b66c9e7b76d69e875e55fe3fc67eed2f77f58c7efc'
-  data.tar.gz: 99768416d98d47fb310db967d247ea1a4f5f6cd493dfd5d4905bf49b569951bba5d971e93fa5f2e2b893428a4c9dc3e537389496da20f7eda58b91c7c106cedf
+  metadata.gz: bad866d4aa2dcc18b21ea1af011fcb5374614dd1961e187d84b24873611466a4099d36aca44da03ece1f9dda8f6ebef54c3f94cbc0312365f6fb20fa8dc526e8
+  data.tar.gz: 467924c84db446676b5c0d3002a815646e2976c3aec76258075f2104158d064eac450b2a57a6763c5947cac145be808346e97469a47a52e920cacb2a8fb407d1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## 0.1.2 - 2021-08-06
+
+- Fix error message markdown parsing. 0f1c3fa4f39c6d7a1628f81e1ea41489b7021254
+- Improve error message when the object path isn't found. 9bdcabd2a90ba94a7e7a1fbbfe872550034c83c3
+- Fix links in documentation + small copy edits. 63d5608fdee6757f314a315509dda31710087f60
+
 ## 0.1.1 - 2021-07-30
 
 - First Implementation, the README will hopefully get you started. Please open an issue if it doesn't 🙂.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    readme_yard (0.1.1)
+    readme_yard (0.1.2)
       tty-markdown (~> 0.7)
       yard-readme (~> 0.1)
 

data/README.md

@@ -1,9 +1,11 @@
-# Readme Yard
+# Readme Yard 🌿
+[![Gem Version](https://badge.fury.io/rb/readme_yard.svg)](https://badge.fury.io/rb/readme_yard)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9fe0012930c3886dbe00/maintainability)](https://codeclimate.com/github/mattruzicka/readme_yard/maintainability)
 
 An experiment in building a better README with
 [YARD](https://yardoc.org).
 Take a look at [README_YARD.md](https://github.com/mattruzicka/readme_yard/blob/main/README_YARD.md)
-to see the template from which this README was generated.
+to see the template from which the README for this project was generated.
 
 If you're reading the README, that means this text is here
 because `{@readme ReadmeYard}` is in
@@ -11,8 +13,8 @@ because `{@readme ReadmeYard}` is in
 and someone ran `readme build` at the command line.
 
 If you're looking at the [source code](https://github.com/mattruzicka/readme_yard/blob/main/lib/readme_yard.rb) or
-[documentation](https://rubydoc.info/github/mattruzicka/readme_yard/master/ReadmeYard),
-_welcome_ to readme yard 🌿 🥏
+[documentation](https://rubydoc.info/github/mattruzicka/readme_yard),
+_welcome_ to readme yard!
 
 ---
 
@@ -44,12 +46,12 @@ The following tags can be used in README_YARD.md to generate YARD documentation
 
 Usage: `{@readme ObjectPath}`
 
-`{@readme ReadmeYard}` is used at the top of this project's README_YARD.md file to generate this README's title and description. `ReadmeYard` references the class located in [lib/readme_yard.rb](lib/readme_yard.rb).
+`{@readme ReadmeYard}` is used at the top of this project's README_YARD.md file to generate this README's title and description. `ReadmeYard` references the class located in [lib/readme_yard.rb](https://github.com/mattruzicka/readme_yard/blob/main/lib/readme_yard.rb).
 
-`{@readme ReadmeYard#command_line_usage}` is used to generate the "Command Line Usage" section above from the comments located above. `ReadmeYard#command_line_usage` references the instance method `command_line_usage` located in [lib/readme_yard.rb](lib/readme_yard.rb).
+`{@readme ReadmeYard#command_line_usage}` is used to generate the "Command Line Usage" section above from the comments located above. `ReadmeYard#command_line_usage` references the instance method `command_line_usage` located in [lib/readme_yard.rb](https://github.com/mattruzicka/readme_yard/blob/main/lib/readme_yard.rb).
 
-`{@readme ReadmeYard.hello_world}` - is used to generate this text in README.md. `ReadmeYard.hello_world` references
-the class method located in [lib/readme_yard.rb](lib/readme_yard.rb).
+`{@readme ReadmeYard.hello_world}` - This object only exists so that you can read this in the README. `ReadmeYard.hello_world` references
+the class method located in [lib/readme_yard.rb](https://github.com/mattruzicka/readme_yard/blob/main/lib/readme_yard.rb).
 
 ### @example
 

data/README_YARD.md

@@ -1,4 +1,6 @@
-# Readme Yard
+# Readme Yard 🌿
+[![Gem Version](https://badge.fury.io/rb/readme_yard.svg)](https://badge.fury.io/rb/readme_yard)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9fe0012930c3886dbe00/maintainability)](https://codeclimate.com/github/mattruzicka/readme_yard/maintainability)
 
 {@readme ReadmeYard}
 
@@ -26,9 +28,9 @@ The following tags can be used in README_YARD.md to generate YARD documentation
 
 Usage: `{@readme ObjectPath}`
 
-`{@readme ReadmeYard}` is used at the top of this project's README_YARD.md file to generate this README's title and description. `ReadmeYard` references the class located in [lib/readme_yard.rb](lib/readme_yard.rb).
+`{@readme ReadmeYard}` is used at the top of this project's README_YARD.md file to generate this README's title and description. `ReadmeYard` references the class located in [lib/readme_yard.rb](https://github.com/mattruzicka/readme_yard/blob/main/lib/readme_yard.rb).
 
-`{@readme ReadmeYard#command_line_usage}` is used to generate the "Command Line Usage" section above from the comments located above. `ReadmeYard#command_line_usage` references the instance method `command_line_usage` located in [lib/readme_yard.rb](lib/readme_yard.rb).
+`{@readme ReadmeYard#command_line_usage}` is used to generate the "Command Line Usage" section above from the comments located above. `ReadmeYard#command_line_usage` references the instance method `command_line_usage` located in [lib/readme_yard.rb](https://github.com/mattruzicka/readme_yard/blob/main/lib/readme_yard.rb).
 
 `{@readme ReadmeYard.hello_world}` - {@readme ReadmeYard.hello_world}
 

data/lib/readme_yard.rb

@@ -8,7 +8,7 @@ require_relative "readme_yard/version"
 #   An experiment in building a better README with
 #   [YARD](https://yardoc.org).
 #   Take a look at [README_YARD.md](https://github.com/mattruzicka/readme_yard/blob/main/README_YARD.md)
-#   to see the template from which this README was generated.
+#   to see the template from which the README for this project was generated.
 #
 #   If you're reading the README, that means this text is here
 #   because `{@readme ReadmeYard}` is in
@@ -16,22 +16,27 @@ require_relative "readme_yard/version"
 #   and someone ran `readme build` at the command line.
 #
 #   If you're looking at the [source code](https://github.com/mattruzicka/readme_yard/blob/main/lib/readme_yard.rb) or
-#   [documentation](https://rubydoc.info/github/mattruzicka/readme_yard/master/ReadmeYard),
-#   _welcome_ to readme yard 🌿 🥏
+#   [documentation](https://rubydoc.info/github/mattruzicka/readme_yard),
+#   _welcome_ to readme yard!
 #
 class ReadmeYard
   class Error < StandardError
     class << self
-      def tag_not_found(tag_name, object_path)
-        new("The `@#{tag_name}` tag could not be found at `#{object_path}`")
+      # TODO: Look for instance method with same name if
+      # class method and vise versa to give a more helpful error.
+      # Also, look for the object path in other scopes.
+      def object_not_found(tag_name, object_path)
+        new("`#{object_path}` could not be found. Perhaps" \
+            " the `@#{tag_name}` tag was moved, mispelled," \
+            " or the `.yardopts` YARD file is missing the file path.")
       end
     end
   end
 
   #
   # @readme
-  #   is used to generate this text in README.md. `ReadmeYard.hello_world` references
-  #   the class method located in [lib/readme_yard.rb](lib/readme_yard.rb).
+  #   This object only exists so that you can read this in the README. `ReadmeYard.hello_world` references
+  #   the class method located in [lib/readme_yard.rb](https://github.com/mattruzicka/readme_yard/blob/main/lib/readme_yard.rb).
   #
   # @example
   #   ReadmeYard.hello_world => "Hello 🌎 🌍 🌏"
@@ -55,7 +60,7 @@ class ReadmeYard
       puts TTY::Markdown.parse(readme_yard.command_line_usage)
     end
   rescue Error => e
-    puts TTY::Markdown.parse(e)
+    puts TTY::Markdown.parse(e.message)
   end
 
   def initialize
@@ -127,7 +132,7 @@ class ReadmeYard
 
   #
   # This method adds the below paragraph to a project's
-  # README.md file, if it doesn't already have one when running
+  # README file, if it doesn't already have one when running
   # `readme build` for the first time.
   #
   # @readme

data/lib/readme_yard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ReadmeYard
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/readme_yard.gemspec

@@ -9,9 +9,6 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
 
   spec.summary = "Build a better README with YARD."
-  spec.description = "An experiment in building a README that summarizes" \
-                     "and contextualizes the code and documentation, without" \
-                     " duplicating them, so as to make keeping it up-to-date easier."
   spec.homepage = "https://github.com/mattruzicka/readme_yard"
   spec.required_ruby_version = ">= 2.5"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readme_yard
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Matt Ruzicka
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-markdown
@@ -38,9 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description: An experiment in building a README that summarizesand contextualizes
-  the code and documentation, without duplicating them, so as to make keeping it up-to-date
-  easier.
+description:
 email:
 executables:
 - readme