Correct the docstring to state that dither is enabled by default

[shanecranor]

closes #13

[shanecranor]

Confused on why the optional parameters are set to None and then set conditionally, rather than setting them directly to the defaults as well.

I can submit a PR to fix this if you think it would be a good idea.

That would be

        invert: bool = False,
        dither: bool = True,

instead of

invert: bool = None
dither: bool = None

.....

if dither is None:
    dither = True
  
      

[miikanissi]

Thanks for raising the issue and fixing this mistake!

I prefer to explicitly initialize the parameters as None in the constructor. This is helpful for mutable objects like lists and dictionaries and it also makes it easier to add more complex logic for setting default values for example the format parameter depends on compression_type here:

zebrafy/zebrafy/zebrafy_image.py

Lines 90 to 95 in 2d875ca

	if format is None:
	if compression_type is None:
	format = "ASCII"
	else:
	format = self._compression_type_to_format(compression_type)
	self.format = format.upper()

So for the sake of consistency every optional parameter is initialized as None.