Repository navigation
Update readme - #21
Conversation
There was a problem hiding this comment.
This paragraph is a bit harsh, from the uppercase "IMPORTANT" to calling the output of "make test" "useless".
I would rewrite it as:
If the tests fail, you can run the failing test(s) in verbose mode using:
./python -m test -v test_that_failed
You should then file a bug report and include the output of this command.
There was a problem hiding this comment.
Maybe we could keep a consistence, ./python -m test -v test_that_failed or make test TESTOPTS="-v" test_that_failed
There was a problem hiding this comment.
@matrixise I'm not sure I understand your point. I switched to make test TESTOPTS="-v test_that_failed" because running the tests is suggested with make test, and there was previously a note about what to do if you built python in a different directory. Reusing make test with TESTOPTS means the different directory question just goes away, but we get exactly the same result.
There was a problem hiding this comment.
It's the possessive form. Maybe a better wording would be "LTO takes advantage of the ability of recent compiler toolchains to optimise..."
There was a problem hiding this comment.
yep, because I have not seen the possessive form, but just a mistake in the text.
There was a problem hiding this comment.
I agree, this is significantly less than ideal. Fixing it also showed that there's a typo in "takes advantages".
These include spelling/grammar fixes, removing some outdated prose, updating some superceded prose, and adding/cleaning up some links.
[skip ci]
commented
Feb 14, 2017
Codecov Report
@@ Coverage Diff @@
## master #21 +/- ##
==========================================
- Coverage 82.38% 82.37% -0.02%
==========================================
Files 1428 1427 -1
Lines 351138 350948 -190
==========================================
- Hits 289291 289087 -204
- Misses 61847 61861 +14Continue to review full report at Codecov.
|
commented
Feb 25, 2017
|
Backport to 3.5 and 2.7? |
This does some modernization and cleanup of the toplevel README. There is still significant room for improvement, but this hits some of the low-hanging fruit.
For reviewers, the first commit is the real change, the second commit is a simple rewrap.