Skip to content
Navigation Menu
Sign in
Products
Platform
GitHub
Repository hosting, code review, and collaboration
Copilot
AI coding agent for tasks, projects, and automated work
Build & Ship
Actions
CI/CD and automation
Code Quality
Quality analysis, fixes, and enforcement
Codespaces
Cloud development environments
Secure
Code Security
Vulnerability detection and remediation
Secret Protection
Secret scanning and leak prevention
All Features
Developers
Learn
Documentation
Training
Certifications
Build
Build with Copilot
Customize Copilot
Integrations
Explore
Trending repos
GitHub Sponsors
Developer articles
Changelog
Changelog
Your source for the latest features, improvements, and fixes across GitHub products, all in one place.
Businesses
By Stage
Enterprises
Team
Startups
Nonprofits
By Industry
Healthcare
Financial services
Manufacturing
Government
See all industries
Evaluate GitHub
Why GitHub
Customer Stories
Business insights
Trust Center
Add-ons
GitHub Advanced Security
Enterprise-grade code security
Copilot for business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Resources
Learn & Connect
Documentation
Resource center
Blog
Events & webinars
Community Forum
Customer Stories
Integrations
Support
Customer support
Training
GitHub Status
Company
About
Partners
Changelog
GitHub Universe
GitHub Universe
The event for developers, by developers — talks, workshops, and what’s next for GitHub.
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
hishamhm
LDoc
Repository navigation
Code
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
More
items
Files
Expand file tree
1.3.8
Breadcrumbs
LDoc
/
tests
/
mod1.lua
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
46 lines (34 loc) · 999 Bytes
1.3.8
Breadcrumbs
LDoc
/
tests
/
mod1.lua
Copy path
Top
File metadata and controls
Code
Blame
46 lines (34 loc) · 999 Bytes
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
----
--
--
always need a doc comment to start!
--
Can have a module with no internal doc comments,
--
although you will get a warning. At least we no
--
longer get a 'end-of-file' if there is no explicit
--
module name.
----
- not a doc comment -----
--
a common style when just specifying an informative comment
--
May start with a doc comment but has trailing hyphens
local
g
--
so g below must be marked as local
---
simple.
--
@
param
x a parameter
function
_M
.
f
(
x
)
end
---
implicit local function.
--
Local functions appear in dump but only in docs if you say --all
local
function
L
(
t
,
v
)
end
---
explicit local function.
--
@
local
here
function
g
(
a
,
b
)
end
---
a table of this module
_M
.
contents
=
{
A
=
'
f
'
,
--
alpha
B
=
'
g
'
--
beta
}
---
another way to do parameters.
function
_M
.
kay
(
a
,
--
ay
b
,
--
bee
)
end
---
a field of this module.
_M
.
constant
=
'
hello
'
---
functions can also be like so.
_M
.
why
=
function
(
x
,
y
)
end
You can’t perform that action at this time.