Regenerated LDoc documentation #89
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated config.ld to use the same docs file in the future instead of doc or having to specifiy it. Added module declaration to nakama/socket.lua so the doc file can be generated. Changed module name in nakama/session.lua to match file structure nakama.util.session => nakama.session Regenerated the docs using ldoc
|
|
Author
|
I think my code editor reformatted the files session.lua and socket.lua when saving, I'll try to avoid doing that in the future. Also this is the first time I contribute to an open source project so if there is any feedback please let me know :) |
DannyIsYog
reviewed
Oct 23, 2025
| Create and check sessions. | ||
| @module nakama.util.session | ||
| @module nakama.session |
There was a problem hiding this comment.
What's the reason to remove the .util?
Author
There was a problem hiding this comment.
The session module (session.lua) is within the nakama directory, so when requiring it you'd do require "nakama.session" and not "nakama.util.session", so I thought the docs should also have the correct path.
DannyIsYog
approved these changes
Oct 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated config.ld to use the same docs file in the future instead of doc or having to specifiy it. Added module declaration to nakama/socket.lua so the doc file can be generated. Changed module name in nakama/session.lua to match file structure nakama.util.session => nakama.session Regenerated the docs using ldoc
Closes #88