BizHawk icon indicating copy to clipboard operation
BizHawk copied to clipboard

resolve #3851 by updating Lua Forms Documentation

Open j-ac opened this issue 6 months ago • 3 comments

Relevant functions gain notice that x and y must be supplied together.

Also standardize some style conventions that seemed to exist but were not regularly followed. Namely:

  • Return value information always follow argument information
  • Arguments use consistent capitalization even at start of a sentence
  • Bullet points do not end with periods

j-ac avatar Jan 31 '24 22:01 j-ac

s/specified/not nil/

Also I was going to add a print when only one of the pair is given. I'll do that if you don't want to.

YoshiRulz avatar Feb 01 '24 06:02 YoshiRulz

Also I was going to add a print when only one of the pair is given. I'll do that if you don't want to.

I'll handle the prinout. What exactly did you mean by the following? Should the language in the docs change?

s/specified/not nil/

j-ac avatar Feb 01 '24 17:02 j-ac

Yes. Since you could "specify" nil explicitly.

YoshiRulz avatar Feb 01 '24 17:02 YoshiRulz