Fixed doc-strings.

This commit is contained in:
Kirill Kuzminykh
2025-01-13 23:06:22 +03:00
parent 74ab1beeee
commit 30ead96f50
3 changed files with 59 additions and 57 deletions
+56 -54
View File
@@ -63,6 +63,61 @@ nix = { version = "0.29.0", default-features = false, features = ["sched"] }
libvips = "1.7"
[profile.test]
opt-level = 3
incremental = true
# debug builds for deps
[profile.dev.package.'*']
opt-level = 3
debug = false
# Strip debug symbols as they are useless with O3 anyway.
strip = "debuginfo"
# debug builds for procmacros
[profile.dev.build-override]
opt-level = 2 # reasonable optimization
codegen-units = 256 # max threading
# When possible - this is generally scary as some procmacros
# will fail without any feedback.
#debug = false
# release build for procmacros - same config as debug build for procmacros
[profile.release.build-override]
opt-level = 2
debug = false # when possible
[profile.release]
opt-level = 3
incremental = true
#lto = true
#codegen-units = 1
strip = true
#[profile.release.package.fast_image_resize]
#codegen-units = 1
[profile.release.package.image]
codegen-units = 1
[profile.release.package.resize]
codegen-units = 1
[package.metadata.release]
pre-release-replacements = [
{ file = "CHANGELOG.md", search = "Unreleased", replace = "{{version}}" },
{ file = "CHANGELOG.md", search = "ReleaseDate", replace = "{{date}}" }
]
[[bench]]
name = "bench_resize"
harness = false
@@ -132,64 +187,11 @@ harness = false
name = "bench_compare_la32f"
harness = false
[[bench]]
name = "bench_color_mapper"
harness = false
[profile.test]
opt-level = 3
incremental = true
# debug builds for deps
[profile.dev.package.'*']
opt-level = 3
debug = false
# Strip debug symbols as they are useless with O3 anyway.
strip = "debuginfo"
# debug builds for procmacros
[profile.dev.build-override]
opt-level = 2 # reasonable optimization
codegen-units = 256 # max threading
# When possible - this is generally scary as some procmacros
# will fail without any feedback.
#debug = false
# release build for procmacros - same config as debug build for procmacros
[profile.release.build-override]
opt-level = 2
debug = false # when possible
[profile.release]
opt-level = 3
incremental = true
#lto = true
#codegen-units = 1
strip = true
#[profile.release.package.fast_image_resize]
#codegen-units = 1
[profile.release.package.image]
codegen-units = 1
[profile.release.package.resize]
codegen-units = 1
[package.metadata.release]
pre-release-replacements = [
{ file = "CHANGELOG.md", search = "Unreleased", replace = "{{version}}" },
{ file = "CHANGELOG.md", search = "ReleaseDate", replace = "{{date}}" }
]
# Header of next release in CHANGELOG.md:
# ## [Unreleased] - ReleaseDate
+1 -1
View File
@@ -179,7 +179,7 @@ struct MappingTablesGroup {
/// This structure holds tables for mapping values of pixel's
/// components in forward and backward directions.
///
/// All pixel types except `I32` and `F32` are supported.
/// All pixel types except `I32` and `F32xN` are supported.
///
/// Source and destination images may have different bit depth of one
/// pixel component.
+2 -2
View File
@@ -4,9 +4,9 @@ use crate::pixels::{F32x2, F32x4, U16x2, U16x4, U8x2, U8x4};
use crate::{ImageError, ImageView, MulDivImagesError, PixelTrait, PixelType};
/// Methods of this structure used to multiply or divide color-channels (RGB or Luma)
/// by alpha-channel. Supported pixel types: U8x2, U8x4, U16x2 and U16x4.
/// by alpha-channel. Supported pixel types: U8x2, U8x4, U16x2, U16x4, F32x2 and F32x4.
///
/// By default, instance of `MulDiv` created with best CPU-extensions provided by your CPU.
/// By default, the instance of `MulDiv` created with the best CPU-extension provided by your CPU.
/// You can change this by using method [MulDiv::set_cpu_extensions].
///
/// # Examples