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

[Docs] Make quick start samples consistent #1735

Merged
merged 6 commits into from
Oct 28, 2023

Conversation

peter-csala
Copy link
Contributor

Pull Request

The issue or feature being addressed

  • The quick start samples were not consistent
  • The strategy summary table was too crowded

Details on the issue fix or feature implementation

  • Split the strategy summary table into two: reactive and proactive
    • Minus one column
    • Also deleted the links "section" from the first column
      • Made the strategy name a relative link to the related quick start
      • The deep links are available at the end of each quick start section
    • Renamed the last column to Mitigation and Prevention respectively
  • Sample codes should embrace best practices IMHO
    • Used static anonymous function where it was possible
    • Used new() instead of the full name of the XYZStrategyOptions
    • Tried to use the same indention everywhere
    • Removed .Build() calls for the sake of consistency

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

@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c62ab82) 84.56% compared to head (e4214e2) 84.56%.
Report is 12 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1735   +/-   ##
=======================================
  Coverage   84.56%   84.56%           
=======================================
  Files         307      307           
  Lines        6790     6790           
  Branches     1043     1043           
=======================================
  Hits         5742     5742           
  Misses        839      839           
  Partials      209      209           
Flag Coverage Δ
linux 84.56% <ø> (ø)
macos 84.56% <ø> (ø)
windows 84.56% <ø> (ø)

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

see 11 files with indirect coverage changes

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

docs/strategies/retry.md Outdated Show resolved Hide resolved
docs/strategies/timeout.md Outdated Show resolved Hide resolved
Copy link
Member

@martincostello martincostello left a comment

Choose a reason for hiding this comment

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

Just one minor suggestion.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@martincostello martincostello merged commit 56ffa14 into App-vNext:main Oct 28, 2023
18 checks passed
@peter-csala peter-csala deleted the update-main-readme branch October 31, 2023 16:27
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.

None yet

3 participants