[Groonga-commit] ranguba/chupa-text at 2cab962 [master] Document Data#path and Data#path=

Back to archive index

Kouhei Sutou null+****@clear*****
Fri Jan 3 17:08:09 JST 2014


Kouhei Sutou	2014-01-03 17:08:09 +0900 (Fri, 03 Jan 2014)

  New Revision: 2cab96280ec0dcbcacb4785988869b02abe91cad
  https://github.com/ranguba/chupa-text/commit/2cab96280ec0dcbcacb4785988869b02abe91cad

  Message:
    Document Data#path and Data#path=

  Modified files:
    lib/chupa-text/data.rb

  Modified: lib/chupa-text/data.rb (+8 -0)
===================================================================
--- lib/chupa-text/data.rb    2014-01-03 17:01:41 +0900 (f75ae4d)
+++ lib/chupa-text/data.rb    2014-01-03 17:08:09 +0900 (416face)
@@ -22,6 +22,9 @@ module ChupaText
   class Data
     attr_writer :body
     attr_accessor :attributes
+
+    # @return [Pathname, nil] The path of the data if the data is for local
+    #   file, `nil` if the data isn't associated with any paths.
     attr_reader :path
 
     # @return [Data, nil] The source of the data. For example, text
@@ -46,6 +49,11 @@ module ChupaText
       @body ||= read_body
     end
 
+    # @path [String, Pathname, nil] path The path for the data. If
+    #   `path` is `nil`, it means that the data isn't associated with
+    #   any paths.
+    #
+    # @return [void]
     def path=(path)
       path = Pathname(path) if path.is_a?(String)
       @path = path
-------------- next part --------------
HTML����������������������������...
下載 



More information about the Groonga-commit mailing list
Back to archive index