-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Ensure exported interfaces have named method parameters #1172
Ensure exported interfaces have named method parameters #1172
Conversation
d023703
to
1b118b2
Compare
Codecov Report
@@ Coverage Diff @@
## master #1172 +/- ##
======================================
Coverage 77.9% 77.9%
======================================
Files 135 135
Lines 7192 7192
======================================
Hits 5603 5603
Misses 1346 1346
Partials 243 243
|
Should we update these e.g. opentelemetry-go/api/metric/config.go Lines 33 to 38 in 77de199
|
I was considering that as well, but in the end decided not to, as it seemed to me that these interfaces are part of the "standardized" style (https://github.com/open-telemetry/opentelemetry-go/blob/master/CONTRIBUTING.md#option) and therefore should be clear enough on their own. But I'm not opposed to including it there as well if that's the preference here. |
I'm on the fence about this. I think that generally the @rakyll do you have thoughts on this? |
I don't think this should block this PR but indeed is a good question. I'm as well on the fence. I think the repeated pattern and having this pattern pretty well documented in our style guide makes this clear. |
In line with the suggestion in #1135 (review), this PR intends to ensure exported interfaces have named method parameters by:
The aim of this change is to improve documentation and to bring about consistency in this matter.
Resolves #1138