Skip to content

Fix XML doc comment on PipelineExecutedArguments - #3201

Merged
martincostello merged 1 commit into
App-vNext:mainfrom
JiuYue0820:fix/executed-args-doc-comment
Aug 16, 2026
Merged

Fix XML doc comment on PipelineExecutedArguments#3201
martincostello merged 1 commit into
App-vNext:mainfrom
JiuYue0820:fix/executed-args-doc-comment

Conversation

@JiuYue0820

@JiuYue0820 JiuYue0820 commented Aug 16, 2026

Copy link
Copy Markdown

Problem

The XML doc comment on Polly.Telemetry.PipelineExecutedArguments says:

Arguments that indicate the pipeline execution started.

However this struct is the payload of the TelemetryUtil.PipelineExecuted event, which is raised by CompositeComponent when the pipeline execution completes, and it carries the execution Duration:

// src/Polly.Core/Utils/Pipeline/CompositeComponent.cs
resilienceContext ... new PipelineExecutedArguments(_timeProvider.GetElapsedTime(timeStamp))

Its sibling PipelineExecutingArguments (the actual "started" event payload) has the same summary text, so one of them is clearly a copy-paste mistake.

Solution

One-word fix: started → finished in the summary of PipelineExecutedArguments.

Verification

  • dotnet build src/Polly.Core/Polly.Core.csproj — 0 warnings, 0 errors.

Co-authored-by: FirmamentalSpring 287222957+FirmaSpring@users.noreply.github.com

@JiuYue0820
Fix XML doc comment on PipelineExecutedArguments
8790184 
The summary said 'pipeline execution started', but this struct is reported by the PipelineExecuted event and carries the execution Duration, i.e. it indicates the pipeline execution has finished. Align the wording with its sibling PipelineExecutingArguments.

Co-authored-by: FirmamentalSpring <287222957+FirmaSpring@users.noreply.github.com>
@JiuYue0820

JiuYue0820 commented Aug 16, 2026

Copy link
Copy Markdown
Author

@dotnet-policy-service agree

@martincostello
martincostello enabled auto-merge (squash) August 16, 2026 19:05
@codecov

codecov Bot commented Aug 16, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.16%. Comparing base (a603169) to head (8790184).
✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #3201   +/-   ##
=======================================
  Coverage   96.16%   96.16%           
=======================================
  Files         311      311           
  Lines        7142     7142           
  Branches     1006     1006           
=======================================
  Hits         6868     6868           
  Misses        221      221           
  Partials       53       53
Flag Coverage Δ
linux 96.16% <ø> (ø)
macos 96.16% <ø> (ø)
windows 96.15% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@martincostello
martincostello merged commit 47e3b41 into App-vNext:main Aug 16, 2026
27 checks passed
This was referenced Sep 14, 2026
Merged
Merged
Closed
Closed
Open
Closed
Closed
Closed
Merged
Merged
Merged
Merged
Closed
Merged
Merged
Closed
Merged
Closed
Open
Closed
Merged
Open
Merged
Merged
This was referenced Sep 25, 2026
Merged
Open
Merged
rdeveen added a commit to rdeveen/azure-security-analyzer-cli that referenced this pull request Sep 25, 2026
@rdeveen
Bump the nuget-dependencies group with 2 updates (#40)
68c1c3c 
Updated
[Microsoft.Extensions.Http.Polly](https://github.com/dotnet/dotnet) from
10.0.11 to 10.0.12.

<details>
<summary>Release notes</summary>

_Sourced from [Microsoft.Extensions.Http.Polly's
releases](https://github.com/dotnet/dotnet/releases)._

No release notes found for this version range.

Commits viewable in [compare
view](https://github.com/dotnet/dotnet/commits).
</details>

Updated [Polly](https://github.com/App-vNext/Polly) from 8.7.0 to 8.8.0.

<details>
<summary>Release notes</summary>

_Sourced from [Polly's
releases](https://github.com/App-vNext/Polly/releases)._

## 8.8.0

## Highlights

* Add `EnableReloadsWithMonitor()` accepting custom `IOptionsMonitor` by
@​arashzjahangiri in App-vNext/Polly#3140
* Return null from `FaultGenerator` when no fault is generated by
@​dualfroz in App-vNext/Polly#3220

## What's Changed

* Update workflow timeout by @​martincostello in
App-vNext/Polly#3106
* Set `SOURCE_DATE_EPOCH` by @​martincostello in
App-vNext/Polly#3115
* Use `NUGET_API_KEY` by @​martincostello in
App-vNext/Polly#3116
* Test refactoring by @​martincostello in
App-vNext/Polly#3132
* Avoid test flakiness by @​martincostello in
App-vNext/Polly#3134
* Group github/codeql-action updates by @​martincostello in
App-vNext/Polly#3147
* Fix wrong word in hedging documentation by @​latent-9 in
App-vNext/Polly#3191
* OSMF sponsorship notice by @​joelhulen in
App-vNext/Polly#3194
* Fix XML doc comment on `PipelineExecutedArguments` by @​JiuYue0820 in
App-vNext/Polly#3201
* Update to xunit v3 by @​martincostello in
App-vNext/Polly#3131
* .NET 11 preparation by @​martincostello in
App-vNext/Polly#3225
* Fix flaky test by @​martincostello in
App-vNext/Polly#3231

## New Contributors

* @​arashzjahangiri made their first contribution in
App-vNext/Polly#3140
* @​latent-9 made their first contribution in
App-vNext/Polly#3191
* @​JiuYue0820 made their first contribution in
App-vNext/Polly#3201
* @​dualfroz made their first contribution in
App-vNext/Polly#3220

**Full Changelog**:
App-vNext/Polly@8.7.0...8.8.0


Commits viewable in [compare
view](App-vNext/Polly@8.7.0...8.8.0).
</details>

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>
This was referenced Sep 25, 2026
Merged
Closed
Open
Closed
Merged
Closed
Merged
Closed
Open
Merged
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@martincostello martincostello martincostello approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@JiuYue0820 @martincostello