Skip to content

Commit

Permalink
improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pix666 committed Jan 28, 2024
1 parent 9ac9a27 commit e3784ab
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ variation.save(processed_image, "dest.jpg")
* Description: Enables or disables upscaling of images.

### `background`
* Type: `Color`
* Type: `str` or `Collection[int]`
* Default: `None`
* Description: Specifies the background color. Used when the mode is set to `FIT`.

Expand All @@ -137,12 +137,12 @@ variation.save(processed_image, "dest.jpg")
### `preprocessors`
* Type: `Iterable[ProcessorProtocol]` or `None`
* Default: `None`
* Description: A list of preprocessors to apply before the main processing step.
* Description: A list of PILKit processors to apply before the main processing step.

### `postprocessors`
* Type: `Iterable[ProcessorProtocol]` or `None`
* Default: `None`
* Description: A list of postprocessors to apply after the main processing step.
* Description: A list of PILKit processors to apply after the main processing step.

### Other Parameters
Additional parameters specific to particular image formats (e.g., `jpeg`, `webp`) can
Expand All @@ -167,15 +167,15 @@ Old code:
```python
Variation(
size=(800, 600),
clip=True
clip=True # can be omitted as it is the default value
)
```

New code:
```python
Variation(
size=(800, 600),
mode=Variation.Mode.FILL,
mode=Variation.Mode.FILL, # can be omitted as it is the default value
)
```

Expand All @@ -189,17 +189,17 @@ Old code:
```python
Variation(
size=(800, 0),
clip=True,
upscale=False
clip=True, # can be omitted as it is the default value
upscale=False # can be omitted as it is the default value
)
```

New code:
```python
Variation(
size=(800, 0),
mode=Variation.Mode.FILL,
upscale=False
mode=Variation.Mode.FILL, # can be omitted as it is the default value
upscale=False # can be omitted as it is the default value
)
```

Expand All @@ -214,7 +214,7 @@ Old code:
```python
Variation(
size=(800, 0),
clip=True,
clip=True, # can be omitted as it is the default value
upscale=True
)
```
Expand All @@ -223,7 +223,7 @@ New code:
```python
Variation(
size=(800, 0),
mode=Variation.Mode.FILL,
mode=Variation.Mode.FILL, # can be omitted as it is the default value
upscale=True
)
```
Expand All @@ -234,7 +234,7 @@ Old code:
```python
Variation(
size=(200, 0),
clip=True,
clip=True, # can be omitted as it is the default value
upscale=True
)
```
Expand Down

0 comments on commit e3784ab

Please sign in to comment.