fix cargo doc warnings

Signed-off-by: Andrei Gherghescu <[email protected]>

Author: andrei-ng

plotly/src/common/color.rs

@@ -1,23 +1,22 @@
-//! This module provides several user interfaces for describing a color to be
-//! used throughout the rest of the library. The easiest way of describing a
-//! colour is to use a `&str` or `String`, which is simply serialized as-is and
-//! passed on to the underlying `plotly.js` library. `plotly.js` supports [`CSS
-//! color formats`], and will fallback to some default color if the color string
-//! is malformed.
-//!
-//! For a more type-safe approach, the `RGB` or `RGBA` structs can be used to
-//! construct a valid color, which will then get serialized to an appropriate
-//! string representation. Cross-browser compatible [`predefined colors`] are
-//! supported via the `NamedColor` enum.
-//!
-//! The `Color` trait is public, and so can be implemented for custom colour
-//! types. The user can then implement a valid serialization function according
-//! to their own requirements. On the whole, that should be largely unnecessary
-//! given the functionality already provided within this module.
-//!
-//! [`CSS color formats`]: https://www.w3schools.com/cssref/css_colors_legal.asp
-//! [`predefined colors`]: https://www.w3schools.com/cssref/css_colors.asp
-
+/// This module provides several user interfaces for describing a color to be
+/// used throughout the rest of the library. The easiest way of describing a
+/// colour is to use a `&str` or `String`, which is simply serialized as-is and
+/// passed on to the underlying `plotly.js` library. `plotly.js` supports [`CSS
+/// color formats`], and will fallback to some default color if the color string
+/// is malformed.
+///
+/// For a more type-safe approach, the `RGB` or `RGBA` structs can be used to
+/// construct a valid color, which will then get serialized to an appropriate
+/// string representation. Cross-browser compatible [`predefined colors`] are
+/// supported via the `NamedColor` enum.
+///
+/// The `Color` trait is public, and so can be implemented for custom colour
+/// types. The user can then implement a valid serialization function according
+/// to their own requirements. On the whole, that should be largely unnecessary
+/// given the functionality already provided within this module.
+///
+/// [`CSS color formats`]: <https://www.w3schools.com/cssref/css_colors_legal.asp>
+/// [`predefined colors`]: <https://www.w3schools.com/cssref/css_colors.asp>
 use dyn_clone::DynClone;
 use erased_serde::Serialize as ErasedSerialize;
 use serde::Serialize;
@@ -116,7 +115,7 @@ impl Serialize for Rgba {
 
 /// Cross-browser compatible [`predefined colors`].
 ///
-/// [`predefined colors`]: https://www.w3schools.com/cssref/css_colors.asp
+/// [`predefined colors`]: <https://www.w3schools.com/cssref/css_colors.asp>
 #[derive(Debug, Clone, Copy, Serialize)]
 #[serde(rename_all = "lowercase")]
 pub enum NamedColor {

plotly/src/configuration.rs

@@ -212,7 +212,7 @@ impl Configuration {
     /// When set it determines base URL for the "Edit in Chart Studio"
     /// `show_edit_in_chart_studio`/`show_send_to_cloud` mode bar button and
     /// the show_link/send_data on-graph link. To enable sending your data to
-    /// Chart Studio Cloud, you need to set both `plotly_server_url` to "https://chart-studio.plotly.com" and
+    /// Chart Studio Cloud, you need to set both `plotly_server_url` to <https://chart-studio.plotly.com> and
     /// also set `showSendToCloud` to `true`.
     pub fn plotly_server_url(mut self, plotly_server_url: &str) -> Self {
         self.plotly_server_url = Some(plotly_server_url.to_string());

plotly/src/layout/mod.rs

@@ -929,7 +929,7 @@ pub struct Shape {
     #[serde(rename = "fillcolor")]
     fill_color: Option<Box<dyn Color>>,
     /// Determines which regions of complex paths constitute the interior. For
-    /// more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule
+    /// more info please visit <https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule>
     #[serde(rename = "fillrule")]
     fill_rule: Option<FillRule>,
     /// Determines whether the shape could be activated for edit or not. Has no
@@ -994,7 +994,7 @@ pub struct NewShape {
     #[serde(rename = "fillcolor")]
     fill_color: Option<Box<dyn Color>>,
     /// Determines the path's interior. For more info please
-    /// visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule
+    /// visit <https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule>
     #[serde(rename = "fillrule")]
     fill_rule: Option<FillRule>,
     /// Sets the opacity of new shapes. Number between or equal to 0 and 1.
@@ -1071,8 +1071,8 @@ pub struct Annotation {
     visible: Option<bool>,
     /// Sets the text associated with this annotation. Plotly uses a subset of
     /// HTML tags to do things like newline (<br>), bold (<b></b>), italics
-    /// (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub>
-    /// <span> are also supported.
+    /// (<i></i>), hyperlinks (<a href='...'></a>). Tags <em></em>, <sup></sup>, <sub></sub>
+    /// <span></span> are also supported.
     text: Option<String>,
     /// Sets the angle at which the `text` is drawn with respect to the
     /// horizontal.

plotly/src/traces/image.rs

@@ -217,7 +217,7 @@ pub struct Image {
     dy: Option<f64>,
 
     /// Specifies the data URI of the image to be visualized. The URI consists
-    /// of "data:image/[<media subtype>][;base64],<data>".
+    /// of "data:image/[\<media subtype\>]\[;base64\],\<data\>".
     source: Option<String>,
 
     /// Sets text elements associated with each (x,y) pair. If a single string,
@@ -245,12 +245,12 @@ pub struct Image {
     /// inserted using %{variable}, for example "y: %{y}". Numbers are
     /// formatted using d3-format's syntax %{variable:d3-format}, for example
     /// "Price: %{y:$.2f}".
-    /// https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details
+    /// <https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format> for details
     /// on the formatting syntax. Dates are formatted using d3-time-format's
     /// syntax %{variable|d3-time-format}, for example "Day:
-    /// %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details
+    /// %{2019-01-01|%A}". <https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format> for details
     /// on the date formatting syntax. The variables available in
-    /// `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data.
+    /// `hovertemplate` are the ones emitted as event data described at this link <https://plotly.com/javascript/plotlyjs-events/#event-data>.
     /// Additionally, every attributes that can be specified per-point (the ones
     /// that are `arrayOk: true`) are available. Anything contained in tag
     /// `<extra>` is displayed in the secondary box, for example

plotly/src/traces/mesh3d.rs

@@ -190,12 +190,12 @@ where
     /// inserted using %{variable}, for example "y: %{y}". Numbers are
     /// formatted using d3-format's syntax %{variable:d3-format}, for example
     /// "Price: %{y:$.2f}".
-    /// https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details
+    /// <https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format> for details
     /// on the formatting syntax. Dates are formatted using d3-time-format's
     /// syntax %{variable|d3-time-format}, for example "Day:
-    /// %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details
+    /// %{2019-01-01|%A}". <https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format> for details
     /// on the date formatting syntax. The variables available in
-    /// `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data.
+    /// `hovertemplate` are the ones emitted as event data described at this link <https://plotly.com/javascript/plotlyjs-events/#event-data>.
     /// Additionally, every attributes that can be specified per-point (the ones
     /// that are `arrayOk: true`) are available. Anything contained in tag
     /// `<extra>` is displayed in the secondary box, for example
@@ -204,8 +204,8 @@ where
     #[serde(rename = "hovertemplate")]
     hover_template: Option<Dim<String>>,
     /// Sets the hover text formatting rulefor `x` using d3 formatting
-    /// mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates
-    /// see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date
+    /// mini-languages which are very similar to those in Python. For numbers, see: <https://github.com/d3/d3-format/tree/v1.4.5#d3-format>. And for dates
+    /// see: <https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format>. We add two items to d3's date
     /// formatter: "%h" for half of the year as a decimal number as well as
     /// "%{n}f" for fractional seconds with n digits. For example,
     /// "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display
@@ -214,8 +214,8 @@ where
     #[serde(rename = "xhoverformat")]
     x_hover_format: Option<String>,
     /// Sets the hover text formatting rulefor `y` using d3 formatting
-    /// mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates
-    /// see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date
+    /// mini-languages which are very similar to those in Python. For numbers, see: <https://github.com/d3/d3-format/tree/v1.4.5#d3-format>. And for dates
+    /// see: <https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format>. We add two items to d3's date
     /// formatter: "%h" for half of the year as a decimal number as well as
     /// "%{n}f" for fractional seconds with n digits. For example,
     /// "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display
@@ -286,8 +286,8 @@ where
     reverse_scale: Option<bool>,
 
     /// Sets the hover text formatting rulefor `z` using d3 formatting
-    /// mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates
-    /// see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date
+    /// mini-languages which are very similar to those in Python. For numbers, see: <https://github.com/d3/d3-format/tree/v1.4.5#d3-format>. And for dates
+    /// see: <https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format>. We add two items to d3's date
     /// formatter: "%h" for half of the year as a decimal number as well as
     /// "%{n}f" for fractional seconds with n digits. For example,
     /// "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display

plotly/src/traces/pie.rs

@@ -78,15 +78,15 @@ where
     /// the first point. An underscore before or after “(x|y)other” will add
     /// a space on that side, only when this field is shown. Numbers are
     /// formatted using d3-format’s syntax %{variable:d3-format}, for example
-    /// “Price: %{y:$.2f}”.  https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax.
-    ///  Dates are formatted using d3-time-format’s syntax
-    /// %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for
+    /// “Price: %{y:$.2f}”.  <https://github.com/d3/d3-format/tree/v1.4.5#d3-format> for details on the formatting syntax.
+    /// Dates are formatted using d3-time-format’s syntax
+    /// %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. <https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format> for
     /// details on the date formatting syntax. The variables available in
-    /// hovertemplate are the ones  emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event- data.
-    ///  Additionally, every attributes that can be specified per-point (the
+    /// hovertemplate are the ones  emitted as event data described at this link <https://plotly.com/javascript/plotlyjs-events/#event-data>.
+    /// Additionally, every attributes that can be specified per-point (the
     /// ones that are arrayOk: true) are available.  Finally, the template
     /// string has access to variables label, color, value, percent and text.
-    /// Anything contained in tag <extra> is displayed in the secondary box, for
+    /// Anything contained in tag \<extra\> is displayed in the secondary box, for
     /// example “<extra>{fullData.name}</extra>”. To hide the secondary box
     /// completely, use an empty tag <extra></extra>.
     #[serde(rename = "hovertemplate")]
@@ -144,8 +144,8 @@ where
     /// axis and colorbar title.text, annotation text rangeselector,
     /// updatemenues and sliders label text all support meta. To access the
     /// trace meta values in an attribute in the same trace, simply use
-    /// %{meta[i]} where i is the index or key of the meta item in question. To
-    /// access trace meta in layout attributes, use %{data[n[.meta[i]} where i
+    /// %{meta\[i\]} where i is the index or key of the meta item in question. To
+    /// access trace meta in layout attributes, use %{data[n[.meta\[i\]} where i
     /// is the index or key of the meta and n is the trace index.
     meta: Option<NumOrString>,
     /// Sets the trace name. The trace name appears as the legend item and on
@@ -186,9 +186,10 @@ where
     /// Template string used for rendering the information text that appear on
     /// points. Note that this will override textinfo. Variables are
     /// inserted using %{variable}, for example “y: %{y}”. Numbers are formatted
-    /// using d3-format’s syntax %{variable:d3-format},  for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax.
-    ///  Dates are formatted using d3-time-format’s syntax
-    /// %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax.
+    /// using d3-format’s syntax %{variable:d3-format},  for example “Price: %{y:$.2f}”.
+    /// <https://github.com/d3/d3-format/tree/v1.4.5#d3-format> for details on the formatting syntax.
+    /// Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example
+    /// “Day: %{2019-01-01|%A}”. <https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format> for details on the date formatting syntax.
     /// Every attributes that can be specified per-point (the ones that are
     /// arrayOk: true) are available. Finally, the template string has
     /// access to variables label, color, value, percent and text.

plotly/src/traces/sankey.rs

@@ -332,7 +332,7 @@ where
     #[serde(rename = "textfont")]
     text_font: Option<Font>,
     /// Sets the value formatting rule using d3 formatting mini-languages which
-    /// are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
+    /// are very similar to those in Python. For numbers, see: <https://github.com/d3/d3-format/tree/v1.4.5#d3-format>.
     #[serde(rename = "valueformat")]
     value_format: Option<String>,
     /// Adds a unit to follow the value in the hover tooltip. Add a space if a

plotly/src/traces/scatter.rs

@@ -146,12 +146,12 @@ where
     /// inserted using %{variable}, for example "y: %{y}". Numbers are
     /// formatted using d3-format's syntax %{variable:d3-format}, for example
     /// "Price: %{y:$.2f}".
-    /// https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details
+    /// <https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format> for details
     /// on the formatting syntax. Dates are formatted using d3-time-format's
-    /// syntax %{variable|d3-time-format}, for example "Day:
-    /// %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details
+    /// syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}".
+    /// <https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format> for details
     /// on the date formatting syntax. The variables available in
-    /// `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data.
+    /// `hovertemplate` are the ones emitted as event data described at this link <https://plotly.com/javascript/plotlyjs-events/#event-data>.
     /// Additionally, every attributes that can be specified per-point (the ones
     /// that are `arrayOk: true`) are available. Anything contained in tag
     /// `<extra>` is displayed in the secondary box, for example