[all-commits] [llvm/llvm-project] eb6097: [lldb][Docs] Various style improvements to the tut...

David Spickett via All-commits all-commits at lists.llvm.org
Wed May 1 02:00:34 PDT 2024


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: eb6097a79e79d03dfc758cc6e79110cbac66d800
      https://github.com/llvm/llvm-project/commit/eb6097a79e79d03dfc758cc6e79110cbac66d800
  Author: David Spickett <david.spickett at linaro.org>
  Date:   2024-05-01 (Wed, 01 May 2024)

  Changed paths:
    M lldb/docs/use/tutorial.rst

  Log Message:
  -----------
  [lldb][Docs] Various style improvements to the tutorial (#90594)

* Replace "we" with either "you" (when talking to the reader) or "lldb"
(when talking about the project).
* Refer to lldb as lldb not LLDB, to match what the user sees on
the command line (I am going to come back later and put the proper name in places where it's talking about the projects themselves)
* Remove a bunch of contractions for example "won't". Which don't (pun
intended) seem like a big deal at first but even I as a native English
speaker find the text clearer with them expanded.
* Use RST's plain text highlighting for keywords and command names.
* Split some very long lines for easier editing in future.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications


More information about the All-commits mailing list