[Lldb-commits] [PATCH] D77582: [CommandInterpreter] Implement UserCommandExists

Jim Ingham via Phabricator via lldb-commits lldb-commits at lists.llvm.org
Tue Apr 7 10:18:55 PDT 2020

jingham added a comment.

In D77582#1967031 <https://reviews.llvm.org/D77582#1967031>, @labath wrote:

> In D77582#1966962 <https://reviews.llvm.org/D77582#1966962>, @teemperor wrote:
> > I think the part of the patch that adds documentation to the existing method should go in (In general all patches that just add documentation have my blanket approval, so please just commit those).
> About that... the existing practice has been to attach documentation to the python versions of these interfaces (`bindings/interface/*.i`). Now we started to add it to the c++ headers too. More documentation is always better, but OTOH repetition creates maintenance problems and increases the risk of it going stale. Should choose one of the two interfaces and put all documentation there (and maybe have a way to auto-generate the other one) ?

We need to keep the documentation in the interface files, that's what produces the python and online doc help.  That's where the vast majority of users of the API will go to find help for it.  But the C++ docs do go into the C++ API docs on the website so they also have some (if not as much) value.  Having a way to salt one from the other would be ideal, though sometimes the Python API needs a little extra color so this isn't entirely trivial.

  rG LLVM Github Monorepo



More information about the lldb-commits mailing list