Skip to content

Commit e831401

Browse files
docs: added channel amount info to convert_to_grayscale methods in Image and ImageList (#834)
Closes #833 ### Summary of Changes docs: added channel amount info to `convert_to_grayscale` methods in `Image` and `ImageList`
1 parent 487854c commit e831401

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

src/safeds/data/image/containers/_image.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,9 @@ def convert_to_grayscale(self) -> Image:
429429
"""
430430
Return a new `Image` that is converted to grayscale.
431431
432+
The new image will have the same amount of channels as the original image.
433+
If you want to change the amount of channels used, please use the method [change_channel][safeds.data.image.containers._image.Image.change_channel].
434+
432435
The original image is not modified.
433436
434437
Returns

src/safeds/data/image/containers/_image_list.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -876,6 +876,9 @@ def convert_to_grayscale(self) -> ImageList:
876876
"""
877877
Return a new `ImageList` with all images converted to grayscale.
878878
879+
The new image list will have the same amount of channels as the original image list.
880+
If you want to change the amount of channels used, please use the method [change_channel][safeds.data.image.containers._image_list.ImageList.change_channel].
881+
879882
The original image list is not modified.
880883
881884
Returns

0 commit comments

Comments
 (0)