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.

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

docs: add example example with code from README/documentation #130

Merged
merged 1 commit into from
Jun 3, 2022

Conversation

shadowspawn
Copy link
Collaborator

@shadowspawn shadowspawn commented May 30, 2022

A pattern I use in Commander is putting all example programs from the documentation into example files with imports so they can be run straight from a checkout of the repo. I find it useful myself to check behaviour matches documentation, besides letting users try them out easily.

This PR adds an example file matching an upstream documentation example, see what you think...

(I do also add examples that don't appear in the documentation for samples of features or usage that are not covered in depth in the README, which we could do here too.)

@bcoe bcoe merged commit 36060cd into pkgjs:main Jun 3, 2022
@shadowspawn shadowspawn deleted the feature/example branch June 3, 2022 12:59
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.

4 participants