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

feat: add ---@private #10

Merged
merged 1 commit into from
Apr 25, 2022
Merged

feat: add ---@private #10

merged 1 commit into from
Apr 25, 2022

Conversation

numToStr
Copy link
Owner

Syntax

---@private

Input

local U = {}

---@private
---This is a private function which is exported
---But not considered as part of the API
function U.private()
    print('I am private!')
end

---Only this will be documented
function U.ok()
    print('Ok! I am exported')
end

---@private
function U.no_emmy()
    print('Private func with no emmylua!')
end

return U

Output

U.ok()                                                                    *U.ok*
    Only this will be documented

@numToStr numToStr merged commit 4f00536 into master Apr 25, 2022
@numToStr numToStr deleted the private branch April 25, 2022 12:50
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.

1 participant