Skip to content

docs(renderer): Link out styles to where used #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 4, 2025
Merged

docs(renderer): Link out styles to where used #304

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bba974b
docs(renderer): Link out styles to where used
epage Sep 4, 2025
dd2169c
docs(renderer): List 'none' style last
epage Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions src/renderer/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,71 +176,72 @@ impl Renderer {

/// Customize [`Renderer::styled`]
impl Renderer {
/// Override the output style for `error`
/// Override the output style for [error][crate::Level::ERROR]
pub const fn error(mut self, style: Style) -> Self {
self.stylesheet.error = style;
self
}

/// Override the output style for `warning`
/// Override the output style for [warnings][crate::Level::WARNING]
pub const fn warning(mut self, style: Style) -> Self {
self.stylesheet.warning = style;
self
}

/// Override the output style for `info`
/// Override the output style for [info][crate::Level::INFO]
pub const fn info(mut self, style: Style) -> Self {
self.stylesheet.info = style;
self
}

/// Override the output style for `note`
/// Override the output style for [notes][crate::Level::NOTE]
pub const fn note(mut self, style: Style) -> Self {
self.stylesheet.note = style;
self
}

/// Override the output style for `help`
/// Override the output style for [help][crate::Level::HELP]
pub const fn help(mut self, style: Style) -> Self {
self.stylesheet.help = style;
self
}

/// Override the output style for line numbers
/// Override the output style for line numbers in the [`Snippet`][crate::Snippet] gutter
pub const fn line_num(mut self, style: Style) -> Self {
self.stylesheet.line_num = style;
self
}

/// Override the output style for emphasis
/// Override the output style for emphasis for the
/// [`primary_title`][crate::Level::primary_title]
pub const fn emphasis(mut self, style: Style) -> Self {
self.stylesheet.emphasis = style;
self
}

/// Override the output style for none
pub const fn none(mut self, style: Style) -> Self {
self.stylesheet.none = style;
self
}

/// Override the output style for [`AnnotationKind::Context`][crate::AnnotationKind::Context]
pub const fn context(mut self, style: Style) -> Self {
self.stylesheet.context = style;
self
}

/// Override the output style for additions
/// Override the output style for [`Patch`][crate::Patch] additions
pub const fn addition(mut self, style: Style) -> Self {
self.stylesheet.addition = style;
self
}

/// Override the output style for removals
/// Override the output style for [`Patch`][crate::Patch] removals
pub const fn removal(mut self, style: Style) -> Self {
self.stylesheet.removal = style;
self
}

/// Override the output style for all other text
pub const fn none(mut self, style: Style) -> Self {
self.stylesheet.none = style;
self
}
}

/// The character set for rendering for decor
Expand Down
Loading