feat(docs): Add illustrative image to README #39
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added an illustrative image to the README file to provide a visual example of using the 'refry' retry decorator. This image enhances the documentation by showing upfront a code snippet demonstrating the decorator's action. Updated the README to include this visual aid for better user understanding.
|
Here's the image, to avoid having a link to my fork (didn't manage how to make it "transferrable"):
|
Switches the URL of the PNG to pydanny's repo (after uploading it in a pull request comment)
Updated the README with the link from this comment, but am not sure if/when Github will throw it away after closing or deleting the pull request... |
pydanny
approved these changes
Aug 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added an illustrative image to the README file to provide a visual example of using the 'refry' retry decorator. This image enhances the documentation by showing upfront a code snippet demonstrating the decorator's action. Updated the README to include this visual aid for better user understanding.