loader: Document the lua loader table.

[imp]

Summary

Document all the public functions from the "loader" table.

Sponsored by: Netflix

[imp]

spell

[sjg]

stand/lua/loader.lua.8

14

built-in

[imp]

simon's fix

[imp]

https://people.freebsd.org/~imp/loader.lua.8.html
has this with a decent rendering.

[imp]

In D43701#996747, @imp wrote:

https://people.freebsd.org/~imp/loader.lua.8.html
has this with a decent rendering.

well, half decent. It's missing a few things, not sure if that's because I'd doing bad things, or because the conversions script just is ill suited for this project.

[imp]

fix printc and add a note about loader.lua being the default file too.

[imp]

-Tlint fixes

[dab]

stand/lua/loader.lua.8

26

"exported from in the" - either something is missing after "from" or what is meant is simply "exported from the" (or "exported by the"

142–143

"change callback function registers at creation" reads oddly to me. Perhaps "change callback function registered at creation"? But maybe there is some terminology in use here with which I'm unfamiliar.

235

Double period

[pauamma_gundo.com]

stand/lua/loader.lua.8

127

135–136

Audience check: What does "globally" mean here? Is it a concept that Lua users are likely familiar with?

155–157

Do you mean x2 and y2 for the last item?

174–181

I'd make that x0, y0, x1, y1 for consistency with other indexes.

192–199

Same as above.

[imp]

update to (hopefully) fix the review comments.

[imp]

stand/lua/loader.lua.8

26

"exported from in the" - either something is missing after "from" or what is meant is simply "exported from the" (or "exported by the"

The following variables are provided by the Lua interpreter in the

135–136

Yes. They'll know about how Lua works.

142–143

I'll just drop it for now. It would be better to give a reference to something else, but the something else that I have is libstand.3, which is horribly out of date.

155–157

Yes.

174–181

I thought of that, but the code uses these odd function parameters. I don't know why. I wanted to make sure they matched in case there's some hidden meaning.

192–199

Same.

[kevans]

LGTM, thanks!

[imp]

After checking with the author, I can make the args consistent.
Do so and add a note about units and origin.