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

Cleanup the Polly.Core README.md #1539

Merged
merged 7 commits into from
Sep 1, 2023
Merged

Conversation

martintmk
Copy link
Contributor

@martintmk martintmk commented Sep 1, 2023

Details on the issue fix or feature implementation

Contributes to #1091

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 Sep 1, 2023
@martintmk martintmk added this to the v8.0.0 milestone Sep 1, 2023
@codecov
Copy link

codecov bot commented Sep 1, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.02% ⚠️

Comparison is base (a7cb07c) 83.93% compared to head (a36f23f) 83.92%.
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1539      +/-   ##
==========================================
- Coverage   83.93%   83.92%   -0.02%     
==========================================
  Files         279      279              
  Lines        6523     6518       -5     
  Branches     1017     1017              
==========================================
- Hits         5475     5470       -5     
  Misses        839      839              
  Partials      209      209              
Flag Coverage Δ
linux ?
macos 83.92% <ø> (-0.02%) ⬇️
windows 83.92% <ø> (-0.02%) ⬇️

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

see 1 file with indirect coverage changes

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

src/Polly.Core/README.md Outdated Show resolved Hide resolved
src/Polly.Core/README.md Outdated Show resolved Hide resolved
src/Polly.Core/README.md Outdated Show resolved Hide resolved
src/Polly.Core/README.md Outdated Show resolved Hide resolved
src/Polly.Core/README.md Outdated Show resolved Hide resolved
src/Polly.Core/README.md Outdated Show resolved Hide resolved
src/Polly.Core/README.md Outdated Show resolved Hide resolved
src/Polly.Core/README.md Show resolved Hide resolved
src/Polly.Core/README.md Outdated Show resolved Hide resolved
src/Polly.Core/README.md Outdated Show resolved Hide resolved
@martincostello
Copy link
Member

I mentioned it somewhere before previously, but I think this is a good opportunity to introduce MarkdownSnippets for the documentation.

This will allow us to define the snippets in code we can compile against, refactor etc. to ensure they still work, and then have them automatically copied over into the README files.

@martintmk
Copy link
Contributor Author

I mentioned it somewhere before previously, but I think this is a good opportunity to introduce MarkdownSnippets for the documentation.

This will allow us to define the snippets in code we can compile against, refactor etc. to ensure they still work, and then have them automatically copied over into the README files.

Love this idea, do you think you can give the infra a shot? Then in follow-up I can do some cleanup.

@martincostello
Copy link
Member

I haven't used it for a while (and you're writing the snippets here already anyway 😄), but it's used in this repo where I set it up a while ago you should be able to copy the things needed from: https://github.com/justeattakeaway/httpclient-interception

@martintmk martintmk mentioned this pull request Sep 1, 2023
@martintmk
Copy link
Contributor Author

I haven't used it for a while (and you're writing the snippets here already anyway 😄), but it's used in this repo where I set it up a while ago you should be able to copy the things needed from: https://github.com/justeattakeaway/httpclient-interception

Let me do this in follow-up.

@martintmk martintmk enabled auto-merge (squash) September 1, 2023 11:08
@martintmk martintmk merged commit 937bf26 into main Sep 1, 2023
@martintmk martintmk deleted the mtomka/update-polly.core-readme branch September 1, 2023 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 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.

2 participants