-
-
Notifications
You must be signed in to change notification settings - Fork 791
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Boy Scout #5808
Boy Scout #5808
Conversation
Codecov Report
@@ Coverage Diff @@
## main #5808 +/- ##
=========================================
Coverage 84.61% 84.61%
Complexity 3794 3794
=========================================
Files 547 547
Lines 12922 12922
Branches 2264 2264
=========================================
Hits 10934 10934
Misses 862 862
Partials 1126 1126 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
@@ -11,4 +11,4 @@ fun yamlConfig(name: String): Config = | |||
resource(name).toURL().openSafeStream().reader().use(YamlConfig::load) | |||
|
|||
fun yamlConfigFromContent(@Language("yaml") content: String): Config = | |||
StringReader(content.trimIndent()).use(YamlConfig::load) | |||
StringReader(content).use(YamlConfig::load) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a potentially breaking change for users of the test library? Unlikely many affected, and trivial fix, but still, maybe worth a mention in release notes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would be shocked if someone use this function. But better safe than sorry. I add the notable change tag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would be shocked if someone use this function.
Can we remove (i.e. make internal
) this function instead of having to mention this in the release notes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we hide it? Isn't it used from other modules?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup it's used all over the places so we'll have to keep it. I'm unsure we need to mention this in the 'notable changes' though
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that no one outside this repo uses this function. And, even if they use it, this shouldn't be a breaking change. The yaml
should be valid even if you don't remove the identation. So I'm ok if you remove the notable changes tag @cortinico.
These are two minor Boy scouts to remove code that is not longer necessary.