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

Use interpolated strings 12 #19003

Merged
merged 7 commits into from Jan 23, 2023

Conversation

CarloToso
Copy link
Contributor

@CarloToso CarloToso commented Jan 21, 2023

PR Summary

Replace string.Format() with new string.Create((IFormatProvider? provider, [InterpolatedStringHandlerArgument(nameof(provider))] ref DefaultInterpolatedStringHandler handler).

PR Context

#18974, I think this is the last one

PR Checklist

@CarloToso CarloToso closed this Jan 21, 2023
@CarloToso CarloToso reopened this Jan 21, 2023
@CarloToso
Copy link
Contributor Author

@iSazonov What is the preferred solution ? streamWriter.NewLine -> streamWriter.NewLine.ToString() or streamWriter.NewLine -> Environment.NewLine

@iSazonov
Copy link
Collaborator

@iSazonov What is the preferred solution ? streamWriter.NewLine -> streamWriter.NewLine.ToString() or streamWriter.NewLine -> Environment.NewLine

We can not use Environment.NewLine since streamWriter can use any value.
streamWriter.NewLine doesn't work but streamWriter.NewLine.ToString()? If so we can use second one.

@iSazonov
Copy link
Collaborator

Maybe it's not worth the effort.

@iSazonov iSazonov self-requested a review January 23, 2023 12:35
Copy link
Collaborator

@iSazonov iSazonov left a comment

Choose a reason for hiding this comment

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

@CarloToso Again an test fails.

@msftbot msftbot bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 23, 2023
@CarloToso
Copy link
Contributor Author

CarloToso commented Jan 23, 2023

@iSazonov I don't know why the tests are failing, it doesn't make any sense. Maybe it was a random error

@msftbot msftbot bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 23, 2023
@CarloToso CarloToso closed this Jan 23, 2023
@CarloToso CarloToso reopened this Jan 23, 2023
@pull-request-quantifier
Copy link

This PR has 17 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +4 -13
Percentile : 6.8%

Total files changed: 3

Change summary by file extension:
.cs : +4 -13

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  👌  👎 (Email)
Customize PullRequestQuantifier for this repository.

@iSazonov iSazonov added the CL-Performance Indicates that a PR should be marked as a performance improvement in the Change Log label Jan 23, 2023
@iSazonov iSazonov assigned iSazonov and unassigned daxian-dbw Jan 23, 2023
@iSazonov iSazonov merged commit 33ba573 into PowerShell:master Jan 23, 2023
42 checks passed
@CarloToso CarloToso deleted the Use-interpolated-strings-12 branch January 23, 2023 17:37
_allowSlicing ? string.Empty : " slicing disallowed",
_constraints == null ? string.Empty : " constraints: " + _constraints,
_version);
return string.Create(CultureInfo.InvariantCulture, $"PSGetIndexBinder indexCount={this.CallInfo.ArgumentCount}{(_allowSlicing ? string.Empty : " slicing disallowed")}{(_constraints == null ? string.Empty : " constraints: " + _constraints)} ver:{_version}");
Copy link
Member

Choose a reason for hiding this comment

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

@iSazonov I think this is way less readable than the original code, don't you think so?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think more about reducing allocations. My suggestions for improvement I outlined in your PR.

@msftbot
Copy link

msftbot bot commented Mar 14, 2023

🎉v7.4.0-preview.2 has been released which incorporates this pull request.🎉

Handy links:

gregsdennis pushed a commit to gregsdennis/PowerShell that referenced this pull request Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-Performance Indicates that a PR should be marked as a performance improvement in the Change Log Extra Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants