Enforce documentation for configs via test suites#293
Conversation
5dd663e to
6033499
Compare
6033499 to
bed15a4
Compare
|
I'm not sure about this. The configs that don't have a config are sorta supposed to be the ones that are self explanatory as to avoid cluttering the config with a ton of documentation(bc then it looks too busy) |
Then they can just be annotated as Undocumented like in this pr, perhaps with a more fitting reason or a simple |
|
This is more so as a safeguard to make sure config options that don’t have comments are intended not to have them. With this change i discovered some like purpur alt keepalive not being documented |
fcacd66 to
7d42f8c
Compare
ac1eaf4 to
f59c447
Compare
80063c3 to
6474344
Compare
|
Blocked by: #292 |
This pull request adds tests for the global and world configuration classes which enforce all options have documentation attached to them.
The verification can be opted out of by annotating the relevant config with
@Undocumentedalong with a reason.In addition to above it completes https://panel.canvasmc.io/dashboard/tasks/cmr0gyjxp00ap0klpfncznk15
Example output