Open
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
Comment on lines
+63
to
+65
| ```python | ||
| Test | ||
| ``` |
There was a problem hiding this comment.
Suggestion: Remove the unnecessary "Test" code block at the end of the installation instructions as it doesn't provide any useful information and could confuse users following the setup process. [general, importance: 7]
Suggested change
| ```python | |
| Test | |
| ``` |
| ## Author | ||
|
|
||
| Cory Spencer <cory@monadical.com> | ||
| Cory Spencer <mailto:cory@monadical.com> |
There was a problem hiding this comment.
Suggestion: The email address formatting is inconsistent with markdown best practices. For email links in markdown, use the standard markdown link syntax rather than HTML. [general, importance: 4]
Suggested change
| Cory Spencer <mailto:cory@monadical.com> | |
| [cory@monadical.com](mailto:cory@monadical.com) |
This file contains hidden or 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
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.
PR Type
Documentation
Description
Improved README formatting and readability
Fixed code block indentation
Added test code block
Updated author email format
Changes walkthrough 📝
README.md
Improve README formatting and readabilityREADME.md