-
Notifications
You must be signed in to change notification settings - Fork 340
docs: Improve Lua documentation generation #7386
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
base: main
Are you sure you want to change the base?
Conversation
|
Autofix has formatted code style violation in this PR. I edit commits locally (e.g: git, github desktop) and want to keep autofix
I do not want the automated commit
If you don't do this, your following commits will be based on the old commit, and cause MERGE CONFLICT. |
* allow for package loading from raw directory specifically when generating documentation * allow for injecting parameter names into documentation
data/raw/generate_docs.lua
Outdated
| > | ||
| > All of these do the same thing: | ||
| > * ``` | ||
| > print(Angle.from_radians(3):to_degrees(a)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I understand correctly, the argument to to_degrees is hidden because we're calling it with colon, so print(Angle.from_radians(3):to_degrees())
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, that's a typo, I'll update it
Purpose of change (The Why)
Lua Documentation page is hard to read / use / navigate
Draft for now while i finish validating the changes
Describe the solution (The How)
St3setINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEESt4lessIS5_ESaIS5_EEDescribe alternatives you've considered
Testing
Additional context
Checklist
Mandatory
closes #1234in Summary of the PR so it can be closed automatically.mainso it won't cause conflict when updatingmainbranch later.deno task docs:genso the Lua API documentation is updated.