Fix details in documentation

This commit is contained in:
Héctor Ramón Jiménez 2019-08-24 03:55:07 +02:00
parent ec66e3fc1b
commit 36d18d979f
9 changed files with 40 additions and 32 deletions

View file

@ -218,7 +218,7 @@ impl State {
/// The type of a [`Button`].
///
/// ![Different buttons drawn by the built-in renderer](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/button_classes.png?raw=true)
/// ![Different buttons drawn by the built-in renderer in Coffee](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/button_classes.png?raw=true)
///
/// [`Button`]: struct.Button.html
#[derive(Debug, Clone, Copy, PartialEq, Eq)]

View file

@ -43,7 +43,7 @@ impl<'a, Message, Renderer> Column<'a, Message, Renderer> {
/// Sets the vertical spacing _between_ elements in pixels.
///
/// Custom margins per element do not exist in Coffee. You should use this
/// Custom margins per element do not exist in Iced. You should use this
/// method instead! While less flexible, it helps you keep spacing between
/// elements consistent.
pub fn spacing(mut self, px: u16) -> Self {

View file

@ -49,7 +49,7 @@ use std::hash::Hash;
/// .label_color(Color::Black);
/// ```
///
/// ![Checkbox drawn by the built-in renderer](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/radio.png?raw=true)
/// ![Checkbox drawn by the built-in renderer in Coffee](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/radio.png?raw=true)
pub struct Radio<Color, Message> {
is_selected: bool,
on_click: Message,

View file

@ -40,7 +40,7 @@ impl<'a, Message, Renderer> Row<'a, Message, Renderer> {
/// Sets the horizontal spacing _between_ elements in pixels.
///
/// Custom margins per element do not exist in Coffee. You should use this
/// Custom margins per element do not exist in Iced. You should use this
/// method instead! While less flexible, it helps you keep spacing between
/// elements consistent.
pub fn spacing(mut self, px: u16) -> Self {

View file

@ -141,13 +141,14 @@ where
}
}
/// The renderer of a [`Text`] fragment.
/// The renderer of a [`Text`] fragment with a generic `Color`.
///
/// Your [`core::Renderer`] will need to implement this trait before being
/// able to use a [`Text`] in your user interface.
/// Your [`Renderer`] will need to implement this trait before being
/// able to use [`Text`] in your [`UserInterface`].
///
/// [`Text`]: struct.Text.html
/// [`core::Renderer`]: ../../core/trait.Renderer.html
/// [`Renderer`]: ../../trait.Renderer.html
/// [`UserInterface`]: ../../struct.UserInterface.html
pub trait Renderer<Color> {
/// Creates a [`Node`] with the given [`Style`] for the provided [`Text`]
/// contents and size.