[PATCH] D106235: Reformulate OrcJIT tutorial doc to make it more clear.

Shivam Gupta via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Sep 1 22:44:23 PDT 2021


xgupta added inline comments.


================
Comment at: llvm/docs/tutorial/BuildingAJIT2.rst:232
+and stores it in the target ``JITDylib``, arranging for it to be passed back
+to layer's emit method when someone requests any symbols defined by the module.
+Each layer can complete its own work by calling the ``emit`` method of its base
----------------
lhames wrote:
> mehdi_amini wrote:
> > I'm not sure this sentence is actually more clear. You're trying to go from a passive form to an active form, but it goes with introducing `someone` as the subject, which does not seem like usual to me when describing some piece of code calling another piece of code.
> > Are you following some guidelines on technical documentation here?
> Agreed -- introducing "someone" here feels slightly awkward. I don't have strong feelings though, and the rest of the changes look good.
Yes, `someone` feels awkward.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D106235/new/

https://reviews.llvm.org/D106235



More information about the llvm-commits mailing list