jimingham wrote: > I don't want to hold this up. Made some suggestions on how I would condense > the descriptions. I stopped after I realized I'd be rewriting most of these. > I also haven't checked how would the formatted version of this look like. > I'll leave it up to you whether you want to apply them or not. > > I have a feeling that when the users ask for documentation, they're ask for > more high-level things like "what is a CompileUnit" or "what's the difference > between a load and a file address", and not "what does Debugger::Create do"
I agree, we need more conceptual documentation on the concepts the SB API's expose. But I think that would be better done in a unified document (either part of the Python Reference or another Document) rather than individual high-level comments at the top of each class. That way when something requires you to explain a couple of classes in concert, you don't have to try to figure out which class to put that information in. https://github.com/llvm/llvm-project/pull/147621 _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits