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.
Provided a more comprehensive overview description. The current README.md is overflowing with commas, unnecessary information, and is overall worded poorly.
The entire README.md should be revised to read more comprehensively.
PR checklist
CHANGELOG-missing
label to this pull request in order to have a snippet generated from its title;or use
scriv create
locally and include the generated file in the pull request, see scriv).Fixes #NNN
somewhere in the description andscriv
changelog entry if this PR addresses an existing issue.Consider using a task list (e.g.,
- [ ] add tests ...
) to indicate remaining to-do items.Thanks for contributing!