-
Notifications
You must be signed in to change notification settings - Fork 258
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
DOC: README update #1195
DOC: README update #1195
Conversation
Codecov ReportBase: 92.16% // Head: 92.16% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #1195 +/- ##
=======================================
Coverage 92.16% 92.16%
=======================================
Files 97 97
Lines 12332 12332
Branches 2534 2534
=======================================
Hits 11366 11366
Misses 645 645
Partials 321 321
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, Zvi! I made a batch of suggestions, but this is overall a tremendous improvement.
As always, feel free to argue back if I have been insufficiently persuasive...
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
I'm glad you approve, thank you for all the fixes and suggestions. |
Tried merging with other sections and using line breaks for some inner-section separation.
Line breaks did not work as expected. Split "Code" section to "Code" and "Tests", and "Distribution" section to "PyPI" and "Linux".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Two small comments.
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
@effigies re-requested one last review to make sure copying to Also, @matthew-brett, is this OK with you? |
* Create top-level header in index.rst * Remove duplicate definition of MIT License URL
Thank you. Not sure whether we should wait any longer before merging this or not 🤷🏼♂️ |
We're good to go if you're happy with my changes. |
Organized a bit, removed some older references, added a bunch of badges.
If and when approved, I will copy the contents to
info.py
.PREVIEW