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

Update docs. #1413

Merged
merged 2 commits into from
Jul 18, 2023
Merged

Update docs. #1413

merged 2 commits into from
Jul 18, 2023

Conversation

martintmk
Copy link
Contributor

@martintmk martintmk commented Jul 18, 2023

Details on the issue fix or feature implementation

Improving the XML docs by moving the default values from <remarks> to <value>.

Confirm the following

  • I started this PR by branching from the head of the default branch
  • I have targeted the PR to merge into the default branch
  • I have included unit tests for the issue/feature
  • I have successfully run a local build

@martintmk martintmk added the v8 Issues related to the new version 8 of the Polly library. label Jul 18, 2023
@martintmk martintmk added this to the v8.0.0 milestone Jul 18, 2023
@codecov
Copy link

codecov bot commented Jul 18, 2023

Codecov Report

Merging #1413 (59476f9) into main (1acb88a) will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1413      +/-   ##
==========================================
+ Coverage   83.78%   83.81%   +0.03%     
==========================================
  Files         273      274       +1     
  Lines        6470     6482      +12     
  Branches     1008     1009       +1     
==========================================
+ Hits         5421     5433      +12     
  Misses        840      840              
  Partials      209      209              
Flag Coverage Δ
linux ?
macos 83.81% <ø> (+0.03%) ⬆️
windows 83.81% <ø> (+0.03%) ⬆️

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

Impacted Files Coverage Δ
...r/AdvancedCircuitBreakerStrategyOptions.TResult.cs 100.00% <ø> (ø)
...re/CircuitBreaker/CircuitBreakerStrategyOptions.cs 100.00% <ø> (ø)
...ker/SimpleCircuitBreakerStrategyOptions.TResult.cs 100.00% <ø> (ø)
...y.Core/Fallback/FallbackStrategyOptions.TResult.cs 100.00% <ø> (ø)
...lly.Core/Hedging/HedgingStrategyOptions.TResult.cs 100.00% <ø> (ø)
src/Polly.Core/PredicateBuilder.TResult.cs 100.00% <ø> (ø)
...Core/Registry/ResilienceStrategyRegistryOptions.cs 100.00% <ø> (ø)
src/Polly.Core/ResilienceContext.cs 100.00% <ø> (ø)
src/Polly.Core/ResilienceStrategyBuilderBase.cs 100.00% <ø> (ø)
src/Polly.Core/ResilienceStrategyOptions.cs 100.00% <ø> (ø)
... and 4 more

... and 3 files with indirect coverage changes

/// The default randomizer is thread safe and returns values between 0.0 and 1.0.
/// </remarks>
/// <value>
/// The default value is thread safe randomizer function that returns values between 0.0 and 1.0.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// The default value is thread safe randomizer function that returns values between 0.0 and 1.0.
/// The default value is a thread-safe randomizer implementation that returns values between 0.0 and 1.0.

@@ -9,9 +9,10 @@ public abstract class ResilienceStrategyOptions
/// Gets or sets the name of the strategy.
/// </summary>
/// <remarks>
/// This name uniquely identifies particular instance of specific strategy.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// This name uniquely identifies particular instance of specific strategy.
/// This name uniquely identifies a particular instance of a specific strategy.

@martintmk martintmk enabled auto-merge (squash) July 18, 2023 14:56
@martintmk martintmk merged commit 38d903e into main Jul 18, 2023
12 checks passed
@martintmk martintmk deleted the mtomka/docs branch July 18, 2023 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v8 Issues related to the new version 8 of the Polly library.
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants