refactor(developer): reorganize messages for adding details #10878
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
…erator Relates to #10207. In order to include message detail in messages, it is helpful to split out the exception messages which have a separate parameter, so that parameter at the same position can be the message detail. Introduces the CompilerMessageSpecWithException function which takes an exceptionVar parameter to achieve this differentiation.
Moved the ERROR_Message line above the Error_Message line for every message in the compiler message files, as it makes the grouping clearer once we start adding message details. For example, see the start of the KmnCompilerMessages class. Also wraps potentially-undefined parameters to the messages with a new function `def`, shorthand for `CompilerMessageDef`, which converts the parameter to '<param>' if it is undefined, which is helpful for documentation.
User Test ResultsTest specification and instructions User tests are not required |
github-actions
bot
added
developer/
common/
developer/compilers/
common/web/
refactor
labels
darcywong00
reviewed
Feb 29, 2024
darcywong00
reviewed
Feb 29, 2024
…s' into refactor/developer/10207-message-detail
Base automatically changed from
refactor/developer/10207-kmn-compiler-message-namespaces
to
beta
March 1, 2024 00:52
|
Changes in this pull request will be available for download in Keyman version 17.0.280-beta |
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.
Relates to #10207.
A bit embarrassed to be doing this much refactoring during beta, but it's targeted and does not change the API surfaces. These changes will make it easier to fully document the compiler messages.
In order to include message detail in messages, it is helpful to split out the exception messages which have a separate parameter, so that parameter at the same position can be the message detail.
Introduces the CompilerMessageSpecWithException function which takes an exceptionVar parameter to achieve this differentiation.
Moved the ERROR_Message line above the Error_Message line for every message in the compiler message files, as it makes the grouping clearer once we start adding message details. For example, see the start of the KmnCompilerMessages class.
Also wraps potentially-undefined parameters to the messages with a new function
def, shorthand forCompilerMessageDef, which converts the parameter to '' if it is undefined, which is helpful for documentation.Next up: the actual documentation generation functions!
@keymanapp-test-bot skip