Core: add docstrings for launcher components #4148
Conversation
github-actions
bot
added
affects: core
Exempt-Medic
added
the
is: documentation
worlds/LauncherComponents.py
Outdated
| type: Type | ||
| """Classification of component intent to filter in the Launcher GUI""" |
There was a problem hiding this comment.
A little confused by what this is actually supposed to mean. Looking at nearby code helps a little, but after reading this, I'm not fully sure what type DOES, if I should set it, what I should set it to/with, and what happens if I choose one option over the others.
There was a problem hiding this comment.
It affects the column and sort order of the Launcher UI.
Right side is Clients, left side is Tools, Misc, and Adjusters in that order.
There was a problem hiding this comment.
I guess my point is that it's not obvious when reading the docstring. At the least, I would expect that making a component a client puts it on the right side.
There was a problem hiding this comment.
part of my intent on this wording is to be generic enough that it doesn't need to be rewritten with #3934
is the typing of type being Type the confusing part? If it was more obvious that there was an enum to reference about potential values help clarify?
There was a problem hiding this comment.
Also when writing it I forgot that the init parameter for type is optional (and gets inferred by substrings of component name), because the actual value on the class is not optional
so that clarification could be expanded upon
There was a problem hiding this comment.
Referencing the enum could help
There was a problem hiding this comment.
updated with a bit more clarifications
ScipioWright
added
waiting-on: core-review
| frozen_name: Optional[str] | ||
| """Recommended to use func instead; Name of the frozen EXE file for this component""" |
There was a problem hiding this comment.
Is EXE the right term here?
There was a problem hiding this comment.
not technically correct on linux i believe, but succinct enough for my tastes (willing to take suggestions)
Exempt-Medic
added
the
waiting-on: author
Co-authored-by: Exempt-Medic <[email protected]>
Co-authored-by: Exempt-Medic <[email protected]>
Co-authored-by: Exempt-Medic <[email protected]>
Exempt-Medic
removed
the
waiting-on: author
What is this fixing or adding?
adds docstrings, mostly off the top of my head with some double-checking,
any wording suggestions and/or clarifications appreciated
How was this tested?
wasn't
If this makes graphical changes, please attach screenshots.