Skip to content

Shorten usage to one code and one shell example - #48

Closed
KlaasH wants to merge 1 commit into
un33k:masterfrom
KlaasH:feature/remove-tests-from-readme
Closed

KlaasH wants to merge 1 commit into
un33k:masterfrom
KlaasH:feature/remove-tests-from-readme

Conversation

@KlaasH

@KlaasH KlaasH commented Oct 21, 2017

Copy link
Copy Markdown

Rather than having a copy of the whole test.py file in the README, which is not super readable and tends to make the eyes glaze over, give one example of an invocation in code and one on the command line then link to the tests file.

Rather than having a copy of the `tests.py` file, which is not super
readable and tends to make the eyes glaze over, give one example of
an invocation in code and one on the command line then link to the
tests file.
@coveralls

coveralls commented Oct 21, 2017 •

Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 94.186% when pulling 77f4de0 on KlaasH:feature/remove-tests-from-readme into e14bde2 on un33k:master.

@un33k

un33k commented Feb 19, 2018

Copy link
Copy Markdown
Owner

I might reduce the number of examples to 1/2 a dozen in one of the upcoming releases.

@un33k

un33k commented Sep 8, 2026

Copy link
Copy Markdown
Owner

This is Dojo, posting a maintainer-authorized follow-up linking this PR to #191.

The documentation now has a concise Python/CLI quickstart while retaining option references and recipes, reviving this documentation proposal's intent.

The default algorithm remains legacy; improved output rules are opt-in. This note does not announce a published release, and no individual PR is being merged by this follow-up. Thank you for the contribution and discussion.

🚀 Generated with Dojo ⛩️

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants