Adding documentation and smoothing out formatting for non-UI code.#10
Adding documentation and smoothing out formatting for non-UI code.#10BeowulfDragon wants to merge 17 commits into
Conversation
Tweaking the documentation of archipelago.gd and adding/changing spacing and indentation (per the GDScript style guide suggested in the Godot docs) to make it less of a wall of code.
ap_location.gd also has a super broken call, but I'm exclusively doing documentation and formatting currently.
Finished writing documentation for all the classes in ap_files. Also fixed some stuff in archipelago.gd. Finished the documentation of command_manager.gd too. Also I was wrong in a previous commit message about an error in APLocation, I just didn't notice the conn member ~300 lines deep into the source for AP.
With an asterisk, since there's a lot of UI in the domain code, so there has been documentation of UI code.
Still need to do one last big read through before submitting a PR.
Making continuation lines more consistent, enforcing spacing around operators, and more spacing in single-line dictionaries.
Also added documentation to SaveFile, as the docs for APSaveManager wouldn't generate without that having documentation to generate.
EmilyV99
left a comment
EmilyV99
left a comment
There was a problem hiding this comment.
did not review archipelago.gd, command_manager.gd, console_command.gd, or connection_info.gd yet (my brain is not prepared for those files atm).
Also didn't actually look at the generated docs in Godot from this yet.
Gonna drop this with the review comments I have so far though, will need to look deeper later (and probably remove the trackerpack stuff from config.gd on my end, which you noticed wasn't being used at all, as it was entirely outdated 😅)
Feel free to bump this in the discord thread if I don't look at it further soon and you have everything I've commented on here cleaned up
Co-authored-by: Emily <35015090+EmilyV99@users.noreply.github.com>
For Network[Thing]s, Create -> Deserialize. While it's maybe technically demarshalling rather than deserialization, deserialization gets the point across enough. Also not using "create" makes it clear that nothing is happening on the server or other clients.
EmilyV99
left a comment
EmilyV99
left a comment
There was a problem hiding this comment.
looked through the command code, still gotta check the two big main files.
|
|
||
|
|
||
| ## Get the autofilled parameters for a command message, up to the number of arguments specified in | ||
| ## [param capacity]. |
There was a problem hiding this comment.
| ## [param capacity]. | |
| ## [param capacity]. A capacity of 0 is unlimited. |
EmilyV99
left a comment
EmilyV99
left a comment
There was a problem hiding this comment.
finally done reviewing 😅 lmk if you have any follow-up questions on anything I commented on
|
|
||
| ## Set the current Archipelago status. | ||
| ## Set to 'CLIENT_GOAL' when the player has 'won'. | ||
| ## Set to [code]CLIENT_GOAL[/code] when the player has won. |
There was a problem hiding this comment.
could this reference ClientStatus.CLIENT_GOAL with some syntax, rather than a generic code tag?
There was a problem hiding this comment.
This is surprisingly not possible. The GDScript documentation syntax can only link to enums as a whole, with no way to refer to a specific member of an enum. Anything before the final dot in a name is treated as a class name, so if a link going to ClientStatus.CLIENT_GOAL is followed, it goes to a blank page because Godot can't find a class named ClientStatus.
It's possible to link to the CLientStatus enum, but the type specifier in the parameters generates a link for that anyway.
Co-authored-by: Emily <35015090+EmilyV99@users.noreply.github.com>
Since seed_name and slot_data are literal values from the protocol, they should go in code blocks.
Co-authored-by: Emily <35015090+EmilyV99@users.noreply.github.com>
2 participants
I was fiddling around with something and wanted to use this library, but found it hard to understand and read, so I have added a bunch of documentation and made the formatting more consistent and readable. I mainly followed the recommended GDScript style guide, except where an alternative style was consistently used and readable. I also broke up as many lines that went over 100 characters as I could, excluding some long strings.
This PR doesn't include documentation for the main UI and app code, only for the files in the
ap_files,autoloads, andmanagersdirectories, andsave_file.gd. Any non-documentation changes should have no functional differences, only changes to formatting.No AI was used in the work done here, I'm just like this.