lib/scrivito/attribute_content.rb in scrivito_sdk-0.65.0.rc1 vs lib/scrivito/attribute_content.rb in scrivito_sdk-0.65.0.rc2

@@ -498,15 +498,19 @@
       raise ScrivitoError, 'No block given' unless block_given?
       attribute_defaults[attribute_name] = block
       nil
     end
 
+    # @api public
     #
-    # This method determines the description that is shown in the UI
-    # and defaults to class name. It can be overriden by a custom value.
+    # Short description of a CMS object or widget type for the UI. The description is displayed
+    # when adding new pages or widgets, for example. As a general rule, it is used whenever no
+    # widget or object instance is available. If there is, the +BasicObj#description_for_editor+
+    # and, respectively, +BasicWidget#description_for_editor+ instance methods are used instead.
     #
-    # @api public
+    # This method can be overridden to customize the description displayed to the editor.
     #
+    # @return [String] the name of the +Class+
     def description_for_editor
       name
     end
 
     #