marcosh/crem
1
1
Fork 0
mirror of https://github.com/marcosh/crem.git synced 2024-08-16 16:00:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

update RenderableVertices documentation

Browse Source
This commit is contained in:
Marco Perone 2023-03-15 12:37:47 +01:00 committed by Marco Perone
parent 900f48423b
commit 7841ffec7f
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/how-to-create-a-machine.md
View File

@ -372,7 +372,8 @@ class RenderableVertices a where
```
It is used to list all the vertices of type `a` so that they can be rendered.
It has a default instance for types `a` satisfying `(Enum a, Bounded a)`, but you can overwrite it for more specific types.
For your own types with `Enum` and `Bounded` instances, you can use the `AllVertices` newtype wrapper in conjunction with `deriving via` to derive a `RenderableVertices` instance which returns the list of all the terms of your type.
Be aware that rendering a graph or topology with vertices of type `a` will try to print out every element of that type. It might not be a good idea to try to print out every value of type `Int`, for example...