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

Update documentation of Diagrams example #281

Closed
ivanperez-keera opened this issue Dec 8, 2023 · 0 comments
Closed

Update documentation of Diagrams example #281

ivanperez-keera opened this issue Dec 8, 2023 · 0 comments
Assignees
@ivanperez-keera
Labels
enhancement
Milestone
0.14.6

Comments

@ivanperez-keera
Copy link
Owner

The diagrams example https://github.com/ivanperez-keera/Yampa/blob/8f703cd4fe1af2e4dcaed02cd2743760343e90f9/yampa/examples/Diagrams.hs has outdated documentation (it refers to cabal v1 commands without the prefix), and the definitions are not documented.

Updating the documentation would help especially newcomers use that example.
@ivanperez-keera ivanperez-keera self-assigned this Dec 8, 2023
@ivanperez-keera ivanperez-keera added this to the 0.14.6 milestone Dec 8, 2023
ivanperez-keera added a commit that referenced this issue Dec 8, 2023
@ivanperez-keera
yampa: Update instructions in example comment. Refs #281.
ac609b0 
The diagrams example has outdated documentation (it refers to cabal v1
commands without the prefix), and the definitions are not documented.

This commit updates the documentation in the module with the v1-prefixed
commands.
ivanperez-keera added a commit that referenced this issue Dec 8, 2023
@ivanperez-keera
yampa: Document diagrams example. Refs #281.
68a7f2e 
This commit adds signatures of all top-level definitions in the Diagrams
example, to make it easier to understand. It also adds (minimal)
comments to each function, and organizes them in a clearer way within
the file.
ivanperez-keera added a commit that referenced this issue Dec 8, 2023
@ivanperez-keera
yampa: Document changes in CHANGELOG. Refs #281.
0385f51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ivanperez-keera ivanperez-keera

Labels
enhancement
Projects
None yet
Milestone
0.14.6
Development

No branches or pull requests
1 participant
@ivanperez-keera