Fix config props defaults and descriptions #76
Merged
+152
−311
Conversation
This file contains hidden or 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 commit simplifies the client properties by setting the default values directly on the properties and removes markdown from the property javadocs. This improves end user experience by adding default values and descriptions to the generated config props docs. Signed-off-by: Chris Bono <chris.bono@gmail.com>
onobc
commented
Dec 4, 2024
| */ | ||
| private String address = "static://localhost:9090"; |
There was a problem hiding this comment.
All of the following changes are of the same pattern "put defaults directly on the fields and only use plain text for javadocs" in order to appease the Automatic Metadata Genarator.
The fields previously had null to indicate if the user had changed the value (i.e. support merges). However, we are not doing in merges and only copying defaults when a new unknown channel is encountered. For this, a simple "copy the default channel" suffices.
The tradeoff for the "merge of properties" is we get default values in the generated config props.
onobc
commented
Dec 4, 2024
| assertThat(newChannel).usingRecursiveComparison().isEqualTo(defaultChannel); | ||
| } | ||
|
|
||
| @Test | ||
| void withUserSpecifiedValuesAreRetained() { |
There was a problem hiding this comment.
While this was previously supported w/ copyDefaultsFrom we were not using it.
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 commit simplifies the client properties by setting the default values directly on the properties and removes markdown from the property javadocs.
This improves end user experience by adding default values and descriptions to the generated config props docs.