Clarify doc for Packer#to_str and Packer#full_pack

byroot · byroot · commit 076a21cc9c50 · 2023-03-24T09:09:25.000+01:00
diff --git a/doclib/msgpack/packer.rb b/doclib/msgpack/packer.rb
@@ -176,9 +176,19 @@ def size
     def empty?
     end
 
+    #
+    # Returns all data in the buffer as a string, and reset the buffer.
+    #
+    # @return [String]
+    #
+    def full_pack
+    end
+
     #
     # Returns all data in the buffer as a string. Same as buffer.to_str.
     #
+    # Does not empty the buffer, in most case _full_pack_ is prefered.
+    #
     # @return [String]
     #
     def to_str

Original file line number	Diff line number	Diff line change
`@@ -176,9 +176,19 @@ def size`
`176`	`176`	`def empty?`
`177`	`177`	`end`
`178`	`178`
	`179`	`+ #`
	`180`	`+ # Returns all data in the buffer as a string, and reset the buffer.`
	`181`	`+ #`
	`182`	`+ # @return [String]`
	`183`	`+ #`
	`184`	`+ def full_pack`
	`185`	`+ end`
	`186`	`+`
`179`	`187`	`#`
`180`	`188`	`# Returns all data in the buffer as a string. Same as buffer.to_str.`
`181`	`189`	`#`
	`190`	`+ # Does not empty the buffer, in most case _full_pack_ is prefered.`
	`191`	`+ #`
`182`	`192`	`# @return [String]`
`183`	`193`	`#`
`184`	`194`	`def to_str`