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

Add examples to documentation #1

Open
trainorpj opened this issue Oct 15, 2017 · 0 comments
Open

Add examples to documentation #1

trainorpj opened this issue Oct 15, 2017 · 0 comments

Comments

@trainorpj
Copy link
Owner

I'd like to have basic, illustrative examples in the documentation for each function. I would like each entry in the docs to look like:

getMiddleCols(matrix)

[Whatever the description of getMiddleCols is]

Example:

getMiddleCols()

[[*, 1, 2, 3, *],          [[1, 2, 3],
 [*, 4, 5, 6, *],    -->    [4, 5, 6],
 [*, 7, 8, 9, *]]           [7, 8, 9]]

If you're going to contribute, please only do one at a time. This would go a long way, and it might make a good first contribution 😃

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

No branches or pull requests

1 participant