Skip to content
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

Change parameter 'location' to a more relevant name #5058

Merged
merged 1 commit into from
Mar 23, 2022

Conversation

hickeyma
Copy link
Contributor

@hickeyma hickeyma commented Mar 22, 2022

The parameter location used in the Retrieve function of the Provider interface does not clearly define what it is.

This PR changes it to uri as it more clearly defines its value, which is a data URI scheme.

Closes #5002.

Signed-off-by: Martin Hickey martin.hickey@ie.ibm.com

@hickeyma hickeyma requested review from a team and bogdandrutu March 22, 2022 11:26
@codecov
Copy link

codecov bot commented Mar 22, 2022

Codecov Report

Merging #5058 (2d175a2) into main (e02b1c4) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #5058   +/-   ##
=======================================
  Coverage   91.04%   91.04%           
=======================================
  Files         180      180           
  Lines       10810    10814    +4     
=======================================
+ Hits         9842     9846    +4     
  Misses        749      749           
  Partials      219      219           
Impacted Files Coverage Δ
config/mapprovider/envmapprovider/mapprovider.go 100.00% <100.00%> (ø)
config/mapprovider/filemapprovider/mapprovider.go 82.35% <100.00%> (ø)
config/mapprovider/yamlmapprovider/mapprovider.go 100.00% <100.00%> (ø)
service/featuregate/flags.go 100.00% <0.00%> (ø)
service/flags.go 88.46% <0.00%> (+2.09%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e02b1c4...2d175a2. Read the comment docs.

@hickeyma
Copy link
Contributor Author

/cc @mx-psi

@hickeyma
Copy link
Contributor Author

I am unsure if this PR needs a changelog. Let me know if its needs one and I can add it.

@bogdandrutu
Copy link
Member

You need a rebase, don't feel strong about changelog, we can skip.

The parameter `location` used in the `Retrieve` function
of the `Provider` interface does not clearly define what it is.

This PR changes it to `uri` as it more clearly defines its value,
which is a data URI scheme.

Closes open-telemetry#5002.

Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
@hickeyma
Copy link
Contributor Author

Thanks for heads up @bogdandrutu, rebased.

Copy link
Member

@bogdandrutu bogdandrutu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/cc @mx-psi please review

Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I was traveling today :) This LGTM, and I think we can consider this a documentation change, so we don't need a changelog

@mx-psi mx-psi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Mar 23, 2022
@bogdandrutu bogdandrutu merged commit 328ca94 into open-telemetry:main Mar 23, 2022
@hickeyma hickeyma deleted the change-location-name branch March 24, 2022 09:41
@hickeyma
Copy link
Contributor Author

Thanks @bogdandrutu @mx-psi for reviews and merge.

Nicholaswang pushed a commit to Nicholaswang/opentelemetry-collector that referenced this pull request Jun 7, 2022
)

The parameter `location` used in the `Retrieve` function
of the `Provider` interface does not clearly define what it is.

This PR changes it to `uri` as it more clearly defines its value,
which is a data URI scheme.

Closes open-telemetry#5002.

Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider better name for Provider "location"
3 participants