Improve config comments & ordering #6108
Open
Conversation
This file contains 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
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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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)