Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Abandoning project in favor of new YARD directive methods.

  • Loading branch information...
commit 0caa30287c7948e30055cf316c2e79655a73fb43 1 parent bb6a645
@cpence authored
Showing with 24 additions and 0 deletions.
  1. +24 −0 README.md
View
24 README.md
@@ -1,5 +1,29 @@
# yard-rails
+**NOTE: THIS PROJECT HAS BEEN ABANDONED.**
+
+You can do pretty much everything you'd want to do as far as Rails attributes, validation, class attributes, and so on, using the new powerful "directive" methods that were implemented into YARD 0.8. For example, define an `attr_accessible` attribute with:
+
+ # @!attribute title
+ # @return [String] the title of this document
+
+Define a `cattr_reader` attribute with:
+
+ # @!attribute [r] facets
+ # @!scope class
+ #
+ # Faceted browsing information that was returned by the last search
+
+Since each of these `@!attribute` directives open up a *full, standard YARD documentation block* for the attribute, you can specify any validations (for example) like this:
+
+ # @!attribute title
+ # @raise [RecordInvalid] if the title is missing (validates :presence)
+ # @return [String] the title of this document
+
+Given the power (and transparency, as opposed to the opacity of plugin methods) of these new documentation methods, I don't see any reason to go out of my way to maintain this gem anymore. If somebody would like to pick up where I left off, feel free to fork and go to town.
+
+----------
+
* [github.com/cpence/yard-rails](http://github.com/cpence/yard-rails/)
* [github.com/cpence/yard-rails/issues](http://github.com/cpence/yard-rails/issues)
* Charles Pence (charles at charlespence.net)
Please sign in to comment.
Something went wrong with that request. Please try again.