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

Filter() description and code snippet clarity and consistency #1628

Merged
merged 5 commits into from
Nov 28, 2020
Merged

Filter() description and code snippet clarity and consistency #1628

merged 5 commits into from
Nov 28, 2020

Conversation

kevinmckinley
Copy link
Contributor

Changes

Reword the description and code snippets for Filter() in OpenTelemetry.Instrumentation.* READMEs.

Grammar and code syntax updated to be consistent between AspNet, AspNetCore, and Http.
Where components were inconsistent, the following decisions were made. These can easily be changed if desired.

  • Lambda parameter syntax. Using of () for single params eg. (x) => {}
  • AspNetInstrumentationOptions parameter name options instead of opt
  • Single statement lambdas do not use {} eg. (x) => x.foo() instead of (x) => { x.foo(); }
  • README code referenced as "code snippet" instead of "example"
  • Tab spacing for code snippets.

Issue driving change: #1186
Previous related PRs: #1615

For significant contributions please make sure you have completed the following items:

@kevinmckinley kevinmckinley requested a review from a team November 27, 2020 19:39
@cijothomas cijothomas merged commit 27b57ea into open-telemetry:master Nov 28, 2020
@kevinmckinley kevinmckinley deleted the patch-1 branch November 28, 2020 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants