Improve config comments & ordering #6108
Conversation
This makes a bit more logical sense in the ordering
This adds slightly more logical ordering to the sign list, keeping them in related groups while sorting them alphabetically. Full alphabetical feels a bit messy, but could still be a valid option.
There was a problem hiding this comment.
Pull Request Overview
This PR improves the configuration file comments for EssentialsX, enhancing clarity, consistency, and punctuation across several resource files.
- Enhanced phrasing and punctuation in kit configuration.
- Standardized comment styles in custom item, worth, and teleport configurations.
- Updated URLs and command syntax for clarity.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Essentials/src/main/resources/kits.yml | Improved comment phrasing and ordering |
| Essentials/src/main/resources/custom_items.yml | Updated comment clarity on alias limitations |
| Essentials/src/main/resources/worth.yml | Refined wording of worth configuration comments |
| Essentials/src/main/resources/tpr.yml | Clarified command syntax in the teleport config |
|
|
||
| # Items not listed in this file will not be sellable on the server | ||
| # Setting the worth to 0 will sell items for free, delete the item or set to -1 to disable. | ||
| # Determines the value of items on the server. |
There was a problem hiding this comment.
This file could do with updating to only use 1.13+ names. Pre-flattening examples could be limited to a comment?
There was a problem hiding this comment.
Good idea, I'd have to learn how the file actually works first though 😂
| change-displayname: true | ||
|
|
||
| # This option will cause Essentials to show players' displaynames instead of usernames when tab completing Essentials commands. | ||
| # This option will cause Essentials to show players' display names instead of usernames when tab completing Essentials commands. |
There was a problem hiding this comment.
I'd be tempted to remove this option - it breaks things more often than it's useful. (I think this used to tab complete nicknames without prefixes/suffixes, but now includes those - so maybe that's a separate bug?)
There was a problem hiding this comment.
Could save it for after the 1.21.5 update
Co-authored-by: MD <[email protected]>
Co-authored-by: MD <[email protected]>
Co-authored-by: MD <[email protected]>
This PR significantly overhauls the comments of the EssentialsX configuration files, ensuring consistency, clarity, and overall improved grammar (validated by Grammarly and LLMs). There are still a few things that must be completed before this is ready to be merged, but no further significant changes are expected. A couple of options have been moved entirely to make more logical sense, but this will not affect any compatibility.
Remaining tasks:
Separate commit: Add 'default' comment to every option(decided this is unnecessary and instead added a link to the default config)