Skip to content

📚 DOCS: Improve documentation for CLI #54

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
Merged
merged 1 commit into from
Oct 8, 2020
Merged

📚 DOCS: Improve documentation for CLI #54

merged 1 commit into from
Oct 8, 2020

Conversation

@westurner
Copy link
Contributor

No description provided.

@welcome
Copy link

welcome bot commented Oct 1, 2020

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉
@westurner westurner mentioned this pull request Oct 1, 2020
Open
@codecov
Copy link

codecov bot commented Oct 1, 2020 •
edited
Loading

Codecov Report

Merging #54 into master will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@ Coverage Diff @@ ## master #54 +/- ## ======================================= Coverage 95.37% 95.37% ======================================= Files 73 73 Lines 3566 3567 +1 ======================================= + Hits 3401 3402 +1  Misses 165 165
Flag Coverage Δ
#pytests 95.37% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
markdown_it/cli/parse.py 77.77% <100.00%> (+0.41%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a4b828c...754e8f8. Read the comment docs.
@westurner westurner changed the title 📚 DOCS: README, cli.parse: docstring, description, usage epilog headings #53 📚 DOCS: README, cli.parse: docstring, description, epilog #53 Oct 1, 2020
@westurner
Copy link
Contributor Author

westurner commented Oct 1, 2020 •
edited
Loading

I ran black cli/parse.py and then git commit --amend; git push -f but the CI hasn't re-run (the pre-commit step)?
@westurner
Copy link
Contributor Author

Where the interactive usage docs say Type Ctrl-D to complete input, or Ctrl-C to exit. is it necessary to always again mention that, in Windows, to do Ctrl-C, you enter Ctrl-Z and then <return>?
@westurner westurner changed the title 📚 DOCS: README, cli.parse: docstring, description, epilog #53 📚 DOCS: README, cli.parse: docstring, description, epilog #53 Oct 1, 2020
@westurner
Copy link
Contributor Author

Does this need any more changes?
@chrisjsewell chrisjsewell changed the title 📚 DOCS: README, cli.parse: docstring, description, epilog #53 📚 DOCS: Improve documentation for CLI Oct 8, 2020
@chrisjsewell chrisjsewell merged commit d14f915 into executablebooks:master Oct 8, 2020
@welcome
Copy link

welcome bot commented Oct 8, 2020

Congrats on your first merged pull request in this project! 🎉
congrats

Thank you for contributing, we are very proud of you! ❤️
@chrisjsewell
Copy link
Member

thats fine thanks
@westurner
Copy link
Contributor Author

westurner commented Oct 8, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants

@westurner @chrisjsewell