README.markdown in method_source-0.1.4 vs README.markdown in method_source-0.2.0
- old
+ new
@@ -3,27 +3,29 @@
(C) John Mair (banisterfiend) 2010
_retrieve the sourcecode for a method_
-*NOTE:* This is nothing fancy; it simply utilizes `Method#source_location`
-in Ruby 1.9
+*NOTE:* This simply utilizes `Method#source_location` in Ruby 1.9; it
+ does not access the live AST.
`method_source` is a utility to return a method's sourcecode as a
Ruby string. Also returns `Proc` and `Lambda` sourcecode.
+Method comments can also be extracted using the `comment` method.
+
It is written in pure Ruby (no C).
-`method_source` provides the `source` method to the `Method` and
+`method_source` provides the `source` and `comment` methods to the `Method` and
`UnboundMethod` and `Proc` classes.
* Install the [gem](https://rubygems.org/gems/method_source): `gem install method_source`
* Read the [documentation](http://rdoc.info/github/banister/method_source/master/file/README.markdown)
* See the [source code](http://github.com/banister/method_source)
-Example: methods
-----------------
+Example: display method source
+------------------------------
Set.instance_method(:merge).source.display
# =>
def merge(enum)
if enum.instance_of?(self.class)
@@ -33,19 +35,32 @@
end
self
end
+Example: display method comments
+--------------------------------
+
+ Set.instance_method(:merge).comment.display
+ # =>
+ # Merges the elements of the given enumerable object to the set and
+ # returns self.
+
Limitations:
------------
-* Only works with Ruby 1.9+ (YARV)
+* Only works with Ruby 1.9+
* Cannot return source for C methods.
* Cannot return source for dynamically defined methods.
Possible Applications:
----------------------
* Combine with [RubyParser](https://github.com/seattlerb/ruby_parser)
for extra fun.
+
+Special Thanks
+--------------
+
+[Adam Sanderson](https://github.com/adamsanderson) for `comment` functionality.