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

Add usage examples at the top of the user-facing modules #341

Closed
2 tasks done
ocramz opened this issue Oct 15, 2023 · 0 comments · Fixed by #358
Closed
2 tasks done

Add usage examples at the top of the user-facing modules #341

ocramz opened this issue Oct 15, 2023 · 0 comments · Fixed by #358
Labels
documentation easy fix

Comments

@ocramz
Copy link
Collaborator

ocramz commented Oct 15, 2023 •
edited
Loading

Best would be to use doctest in the Haddock documentation, see e.g https://quchen.github.io/generative-art/generative-art-0.1.0.0/src/Geometry.Core.html for a cool example
@ocramz ocramz mentioned this issue Dec 16, 2023
Merged
ocramz added a commit that referenced this issue Dec 17, 2023
@ocramz
Docs and examples #341 (#358)
c1eb32b 
* add docs and examples

* make examples copypastable

* links

* stack exec example

* examples links

* haddock

---------

Co-authored-by: Marco Zocca <marco.zocca@unfoldml.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation easy fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs and examples #341 ocramz/scotty
1 participant
@ocramz