Skip to content

Conversation

@usagirei
Copy link
Collaborator

@usagirei usagirei commented Oct 21, 2025

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)

  • Places docstrings inside a blockquote
  • Hides operators (__eq, __lt, __tostring, etc)
  • Distinguish free functions from methods
    • Add a note regarding functions / methods in Lua
  • Adds clickable links in function signatures / member types for ease of navigation
  • Show demangled names for types without mappings
    • Goodbye St3setINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEESt4lessIS5_ESaIS5_EE

Describe alternatives you've considered

Testing

Additional context

Checklist

Mandatory

@github-actions github-actions bot added docs PRs releated to docs page src changes related to source code. JSON related to game datas in JSON format. lua PRs and issues related to Lua scripting labels Oct 21, 2025
@autofix-ci
Copy link
Contributor

autofix-ci bot commented Oct 21, 2025

Autofix has formatted code style violation in this PR.

I edit commits locally (e.g: git, github desktop) and want to keep autofix
  1. Run git pull. this will merge the automated commit into your local copy of the PR branch.
  2. Continue working.
I do not want the automated commit
  1. Format your code locally, then commit it.
  2. Run git push --force to force push your branch. This will overwrite the automated commit on remote with your local one.
  3. Continue working.

If you don't do this, your following commits will be based on the old commit, and cause MERGE CONFLICT.

@scarf005 scarf005 changed the title refactor: Improve Lua documentation generation docs: Improve Lua documentation generation Oct 21, 2025
* allow for package loading from raw directory specifically when generating documentation
* allow for injecting parameter names into documentation
>
> All of these do the same thing:
> * ```
> print(Angle.from_radians(3):to_degrees(a))
Copy link

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())

Copy link
Collaborator Author

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

@usagirei usagirei marked this pull request as ready for review November 6, 2025 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs PRs releated to docs page JSON related to game datas in JSON format. lua PRs and issues related to Lua scripting src changes related to source code.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants