Skip to content

Commit

Permalink
Fix documentation comments for Rust 1.66. (#3310)
Browse files Browse the repository at this point in the history
Somewhere after 1.64 but by 1.66, `rustdoc` started checking for
unmatched HTML tags in doc strings, meaning that text like

    /// Convenience function turning Option<Selector> into this enum.

causes problems, since `rustdoc` will pass through `<Selector>` as
HTML tag, which browsers displaying the output will misunderstand.
  • Loading branch information
jimblandy authored Dec 19, 2022
1 parent 46831a8 commit de070b2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion wgpu-core/src/track/texture.rs
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ enum TextureStateProvider<'a> {
TextureSet { set: &'a TextureStateSet },
}
impl<'a> TextureStateProvider<'a> {
/// Convenience function turning Option<Selector> into this enum.
/// Convenience function turning `Option<Selector>` into this enum.
fn from_option(selector: Option<TextureSelector>, state: TextureUses) -> Self {
match selector {
Some(selector) => Self::Selector { selector, state },
Expand Down

0 comments on commit de070b2

Please sign in to comment.