Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

resolve #3851 by updating Lua Forms Documentation #3855

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

j-ac
Copy link
Contributor

@j-ac j-ac commented Jan 31, 2024

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

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
@YoshiRulz
Copy link
Member

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.

@j-ac
Copy link
Contributor Author

j-ac commented Feb 1, 2024

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/

@YoshiRulz
Copy link
Member

Yes. Since you could "specify" nil explicitly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants