Just a few words to introduce the extra optional argument to Python summaries
authorEnrico Granata <egranata@apple.com>
Sat, 22 Nov 2014 00:06:30 +0000 (00:06 +0000)
committerEnrico Granata <egranata@apple.com>
Sat, 22 Nov 2014 00:06:30 +0000 (00:06 +0000)
llvm-svn: 222594

lldb/www/varformats.html

index a36c005..087fc86 100755 (executable)
@@ -903,6 +903,10 @@ def function (valobj,internal_dict):<br/>
             
             </p>
             
+            <p>Starting in SVN r222593, Python summary formatters can optionally define a third argument: <code>options</code><br/>
+              This is an object of type lldb.SBTypeSummaryOptions that can be passed into the formatter, allowing for a few customizations of the result.
+              The decision to adopt or not this third argument - and the meaning of options thereof - is within the individual formatters' writer.<br/>
+
             </div>
         </div>