Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document features #28

Open
LilyFoote opened this issue Oct 18, 2022 · 2 comments
Open

Document features #28

LilyFoote opened this issue Oct 18, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@LilyFoote
Copy link

This tool looks great! I hope to see it continue to improve and reach feature parity with Coverage.py.

It would be really useful to have each of the features you support explicitly documented, with instructions on how to use them. Currently I feel like I have to dig through the issues and source code to understand what's possible/supported.
@jaltmayerpizzorno jaltmayerpizzorno added the documentation Improvements or additions to documentation label Oct 21, 2022
@jaltmayerpizzorno
Copy link
Collaborator

Thank you! I think currently running python -m slipcover --help would be your best source.

@antoniogamizbadger
Copy link

Maybe that should be in the README?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@LilyFoote @jaltmayerpizzorno @antoniogamizbadger