creativescala / doodle

Compositional vector graphics in Scala / Scala.JS
https://creativescala.org/doodle/
Apache License 2.0
327 stars 75 forks source link

Consistent naming of writers #146

Closed noelwelsh closed 5 months ago

noelwelsh commented 5 months ago

There are several types that convert a Picture into something else:

There will probably be a lot more in the future. Let's name this concept and have a consistent naming scheme for the types that implement it.

I propose calling this a writer. Methods on different writers will be different (e.g. a FileWriter will take a file name, where as a Base64Writer will not.) but it is possible to implement a marker trait, as is done for Algebra and Format.

jCabala commented 5 months ago

Should the documentation be written in the effect specific README.md file?

image
noelwelsh commented 5 months ago

Documentation lives here: https://github.com/creativescala/doodle/blob/main/docs/src/pages/README.md