[all-commits] [llvm/llvm-project] 0bc766: [ADT] Fix FoldingSet documentation typos

Brian Gesiak via All-commits all-commits at lists.llvm.org
Fri Dec 27 18:28:11 PST 2019


  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: 0bc7665d988218d7c9a907e52f0e1c7fc01601a2
      https://github.com/llvm/llvm-project/commit/0bc7665d988218d7c9a907e52f0e1c7fc01601a2
  Author: Brian Gesiak <modocache at gmail.com>
  Date:   2019-12-27 (Fri, 27 Dec 2019)

  Changed paths:
    M llvm/include/llvm/ADT/FoldingSet.h

  Log Message:
  -----------
  [ADT] Fix FoldingSet documentation typos

* "If found then M with be non-NULL" should be "will be non-NULL".
* The documentation examples (1) and (2) declare and use a variable
  `MyNode *M`, but examples (3) and (4) switch midway to using a
  variable named `N`. Unify the examples to all use `M`.
* The examples demonstrate the use of member functions of
  `FoldingSet`, but (3) and (4) invoke these as if they were free
  functions. Modify them to call member functions on the `MyFoldingSet`
  object constructed in the code above example (1).




More information about the All-commits mailing list