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 consistent naming of writers #152

Merged
merged 5 commits into from
Mar 18, 2024
Merged

Conversation

jCabala
Copy link
Collaborator

@jCabala jCabala commented Mar 15, 2024

I renamed all "writing" effects to have a suffix Writer, updated sytax and moved Java2dBuffereImageWriter to a separate file. Additionally, I moved the renderBufferedImage() method from Java2dWriter to a Java2d as it is now used by multiple files. I decided not to proceed with creating a separate file to store all of the actuall writer objects as with the renderBufferedImage() method moved it seems to make more sense to leave them as they are (otherwise this file would become very large very quickly).

Closes #146

Copy link
Contributor

@noelwelsh noelwelsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Only one little suggestion to make it a bit easier to read the code.

import doodle.algebra.Algebra
import doodle.algebra.Picture
import doodle.core.format.Format

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/** Marker trait for effects that write a picture to a file or some other type. */

Adding basic ScalaDoc, especially for the parts of the code that are user level concepts, is a good practice.

@jCabala jCabala requested a review from noelwelsh March 18, 2024 10:15
@noelwelsh
Copy link
Contributor

Great!

@noelwelsh noelwelsh merged commit 643f034 into creativescala:main Mar 18, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consistent naming of writers
2 participants