Skip to content

Commit

Permalink
chore: doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Walther committed Oct 16, 2023
1 parent a417abe commit 8d63030
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion clovers/src/colorize.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use palette::{
};
use rand::rngs::SmallRng;

/// The main coloring function. Sends a [Ray] to the [Scene], sees if it hits anything, and eventually returns a [Color]. Taking into account the [Material](crate::materials::Material) that is hit, the method recurses with various adjustments, with a new [Ray] started from the location that was hit.
/// The main coloring function. Sends a [`Ray`] to the [`Scene`], sees if it hits anything, and eventually returns a [`LinSrgb`]. Taking into account the [Material](crate::materials::Material) that is hit, the method recurses with various adjustments, with a new [`Ray`] started from the location that was hit.
#[must_use]
pub fn colorize(
ray: &Ray,
Expand Down
2 changes: 1 addition & 1 deletion clovers/src/materials/dielectric.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ pub struct Dielectric {
/// Refractive index of the material. Used for calculating the new direction of a ray when entering the material at an angle. Follows Snell's law of refraction. Default value: 1.5, based on typical window glass.
#[cfg_attr(feature = "serde-derive", serde(default = "default_index"))]
pub refractive_index: Float,
/// Color of the material. Used for colorizing the rays. Default value: [`Color::new(1.0, 1.0, 1.0)`](crate::color::Color), producing a fully transparent, clear glass.
/// Color of the material. Used for colorizing the rays. Default value: [`(1.0, 1.0, 1.0)`], producing a fully transparent, clear glass.
#[cfg_attr(feature = "serde-derive", serde(default = "default_color"))]
pub color: Srgb,
}
Expand Down

0 comments on commit 8d63030

Please sign in to comment.