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

Readme improvement #1054

Closed
postb99 opened this issue Mar 14, 2023 · 1 comment · Fixed by #1599
Closed

Readme improvement #1054

postb99 opened this issue Mar 14, 2023 · 1 comment · Fixed by #1599
Labels
v8 Issues related to the new version 8 of the Polly library.
Milestone

Comments

@postb99
Copy link

postb99 commented Mar 14, 2023

Hello, I think that step 2 contains a lot of code snippets, thus I had some troubles finding step 3, a lot of scroll... and this made me loose some time understanding how to execute some code through the configured policy. Sorry for this user issue.

Maybe step 2 can present only one code snippet and the other policy names/behaviors/samples could be listed/linked after code snippet... after main steps in the Readme?

After reading again, the samples are a bit more detailed than table at step 1 (Retry and RetryForever vs only Retry) and they are linked from the table as quick start. I fully agree to keep all quick starts in the Readme itself.

Hoping I'm clear, best regards,

Step 2: https://github.com/App-vNext/Polly#step-2--specify-how-the-policy-should-handle-those-faults
Step 3: https://github.com/App-vNext/Polly#step-3--execute-code-through-the-policy

@martincostello martincostello added this to the v8.0.0 milestone Jun 16, 2023
@martincostello martincostello added the v8 Issues related to the new version 8 of the Polly library. label Jun 16, 2023
@martincostello
Copy link
Member

We are aiming to improve the README as part of the v8 release.

@martintmk martintmk mentioned this issue Sep 25, 2023
4 tasks
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 a pull request may close this issue.

2 participants