Updating enums Script for Displaying Languages #268
Merged
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
✅ Deploy Preview for splashkit-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
EthanRin
approved these changes
Dec 11, 2024
There was a problem hiding this comment.
This is a great update for the SplashKit website that enhances the clarity and capabilities of the documentation page. I have pulled this PR and tested on my local fork and have found no error. This code is well structured with comments on hard to understand area, enhancing code readability for further students.
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Description
This pull request updates the
components.cjsfile to support a new feature I've introduced in the translator. Previously, enum signatures were displayed only for C++ on the SplashKit website. The changes in the translator now allow for pulling and displaying enum syntax for multiple languages, enhancing the website's documentation capabilities.To demonstrate the functionality and ensure compatibility, the updated
api.jsonis included in this pull request. It is essential for being able to preview the changes, as the updates introduce modifications that are incompatible with the previous build configuration.The pull request for the translator change is here - thoth-tech/splashkit-translator#17
Type of change
How Has This Been Tested?
Testing was conducted using the updated
api.jsongenerated from the modified translator. This ensured that the new enum formatting was accurately reflected in the documentation and did not introduce errors during the build process.Testing Checklist