-
Notifications
You must be signed in to change notification settings - Fork 193
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
Declutter README #2232
Declutter README #2232
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as off-topic.
This comment was marked as off-topic.
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.
Overall looks good, a few comments
4ab1416
to
8c714e7
Compare
Codecov Report
@@ Coverage Diff @@
## dev #2232 +/- ##
==========================================
+ Coverage 73.04% 73.07% +0.02%
==========================================
Files 77 77
Lines 8344 8333 -11
==========================================
- Hits 6095 6089 -6
+ Misses 2249 2244 -5
... and 1 file with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
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! Only added a couple of small suggestions. Thank you 🙂
Co-authored-by: Júlia Mir Pedrol <[email protected]>
Only last comment is I wonder if we should have more emphasis on where to find the documentation, I wonder if it needs it's own section and a sentence saying 'check the website' sortof thing (rather than just at the bottom of the usage section) |
it's also at the bottom of the output section. Personally, I think it's ok as it is, but I don't mind another link (or maybe badge?). |
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.
Massive improvement, thanks @grst!
Made a few suggestions, let me know what you think.
Co-authored-by: Phil Ewels <[email protected]>
Co-authored-by: Phil Ewels <[email protected]>
Co-authored-by: Phil Ewels <[email protected]>
Co-authored-by: Phil Ewels <[email protected]>
Co-authored-by: Phil Ewels <[email protected]>
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.
Couple of very minor grammar changes, otherwise LGTM to merge.
Massive improvement - thank you @grst!
Simplifies README as discussed in #2186.
Close #2186.
PR checklist
CHANGELOG.md
is updated[ ] If you've fixed a bug or added code that should be tested, add tests![ ] Documentation indocs
is updated