Document #raw_path

nanoc · Oct 7, 2017 · 0f3ed2f · 0f3ed2f
1 parent 503a119
commit 0f3ed2f
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/lib/nanoc/base/views/compilation_item_rep_view.rb b/lib/nanoc/base/views/compilation_item_rep_view.rb
@@ -2,7 +2,13 @@
 
 module Nanoc
   class CompilationItemRepView < ::Nanoc::BasicItemRepView
-    # @api private
+    # Returns the item rep’s raw path. It includes the path to the output
+    # directory and the full filename.
+    #
+    # @param [Symbol] snapshot The snapshot for which the path should be
+    #   returned.
+    #
+    # @return [String] The item rep’s raw path.
     def raw_path(snapshot: :last)
       @context.dependency_tracker.bounce(unwrap.item, compiled_content: true)