improve some high-level help text & documentation #301
Conversation
| The following exit codes are available for mutmut (as documented for the CLI run command): | ||
| * 0 if all mutants were killed (OK_KILLED) | ||
| * 1 if a fatal error occurred | ||
| * 2 if one or more mutants survived (BAD_SURVIVED) |
There was a problem hiding this comment.
I think this info would now be duplicated by the changes I proposed to the main run function, which I think is where this info belongs to be accessible to the user. I would be happy to trim down or remove the info here, if needed.
mutmut/__main__.py
Outdated
| print() | ||
| print("To show the results: mutmut results") | ||
| print() | ||
| print("To generate HTML report: mutmut html") |
There was a problem hiding this comment.
These lines I don't like. Won't this output that help message ALWAYS? That's wrong.
There was a problem hiding this comment.
Now removed. I had thought this could be helpful for newcomers, just like mutmut results shows how to show and apply a surviving mutant. Maybe another, shorter hint could be ideal, even if it just says to do mutmut --help for pointers on what to do next.
brodycj
force-pushed
the
improve-high-level-documentation
branch
from
d096ab1
to
bbf6e91
Compare
|
I have removed the extra output from the end of |
|
Thanks! |
Thanks in advance for the consideration.