feat: Optimize Encoding Functions and Add Descriptive Comments #3543
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 pull request introduces several improvements to the encoding package: 1. **Refactoring for Code Reusability**: Introduced `encodeToJSON` to handle the encoding of TOML and YAML data to JSON, reducing duplicated code between `TomlToJson` and `YamlToJson`. 2. **Clearer Commenting**: Added English comments to each function for better clarity on its purpose and functionality. 3. **Enhanced Key Processing**: Updated functions related to key processing (`convertKeyToString` and `toStringKeyMap`) to ensure more consistent handling and conversion, particularly for ensuring map keys are of string type. These changes aim to improve the readability, maintainability, and efficiency of the code in the `encoding` package. Feedback or suggestions for further refinements are welcome!
Codecov Report
|
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 pull request introduces several improvements to the encoding package:
encodeToJSONto handle the encoding of TOML and YAML data to JSON, reducing duplicated code betweenTomlToJsonandYamlToJson.convertKeyToStringandtoStringKeyMap) to ensure more consistent handling and conversion, particularly for ensuring map keys are of string type.