[all-commits] [llvm/llvm-project] acdc74: [lldb][docs] Cleanup the Python doc strings for SB...

Raphael Isemann via All-commits all-commits at lists.llvm.org
Sun Jan 17 07:52:36 PST 2021


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: acdc74568927d47f94816e73b6e105c9460cc3e4
      https://github.com/llvm/llvm-project/commit/acdc74568927d47f94816e73b6e105c9460cc3e4
  Author: Raphael Isemann <teemperor at gmail.com>
  Date:   2021-01-17 (Sun, 17 Jan 2021)

  Changed paths:
    M lldb/bindings/interface/SBAttachInfo.i
    M lldb/bindings/interface/SBBreakpoint.i
    M lldb/bindings/interface/SBCommunication.i
    M lldb/bindings/interface/SBData.i
    M lldb/bindings/interface/SBExecutionContext.i
    M lldb/bindings/interface/SBFileSpecList.i
    M lldb/bindings/interface/SBFrame.i
    M lldb/bindings/interface/SBHostOS.i
    M lldb/bindings/interface/SBInstruction.i
    M lldb/bindings/interface/SBLanguageRuntime.i
    M lldb/bindings/interface/SBLaunchInfo.i
    M lldb/bindings/interface/SBLineEntry.i
    M lldb/bindings/interface/SBMemoryRegionInfoList.i
    M lldb/bindings/interface/SBModuleSpec.i
    M lldb/bindings/interface/SBPlatform.i
    M lldb/bindings/interface/SBQueue.i
    M lldb/bindings/interface/SBQueueItem.i
    M lldb/bindings/interface/SBReproducer.i
    M lldb/bindings/interface/SBStringList.i
    M lldb/bindings/interface/SBThreadPlan.i
    M lldb/bindings/interface/SBTrace.i
    M lldb/bindings/interface/SBTraceOptions.i
    M lldb/bindings/interface/SBType.i
    M lldb/bindings/interface/SBTypeEnumMember.i
    M lldb/bindings/interface/SBVariablesOptions.i
    M lldb/bindings/python/python-extensions.swig

  Log Message:
  -----------
  [lldb][docs] Cleanup the Python doc strings for SB API classes

The first line of the doc string ends up on the SB API class summary at
the root page of the Python API  web page of LLDB. Currently many of the
descriptions are missing or are several lines which makes the table really
hard to read.

This just adds the missing docstrings where possible and fixes the formatting
where necessary.




More information about the All-commits mailing list