Skip to content

Commit 0cffd1f

Browse files
NeutroniSiegeLord
authored andcommitted
documentation commit indentation fixes
1 parent 5a1ea96 commit 0cffd1f

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

gnuplot/src/axes2d.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -683,8 +683,8 @@ impl Axes2D
683683
/// * `BorderColor` - Sets the color of the border
684684
/// * `Color` - Sets the color of the box fill
685685
/// * `FillAlpha` - Sets the transparency of the box fill
686-
/// * `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
687-
/// previously set box width, or be set to the spacing of the boxes
686+
/// * `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
687+
/// previously set box width, or be set to the spacing of the boxes
688688
pub fn boxes<
689689
'l,
690690
Tx: DataType,
@@ -720,8 +720,8 @@ impl Axes2D
720720
/// * `BorderColor` - Sets the color of the border
721721
/// * `Color` - Sets the color of the box fill
722722
/// * `FillAlpha` - Sets the transparency of the box fill
723-
/// * `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
724-
/// previously set box width, or be set to the spacing of the boxes
723+
/// * `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
724+
/// previously set box width, or be set to the spacing of the boxes
725725
pub fn box_error_delta<
726726
'l,
727727
Tx: DataType,
@@ -763,8 +763,8 @@ impl Axes2D
763763
/// * `BorderColor` - Sets the color of the border
764764
/// * `Color` - Sets the color of the box fill
765765
/// * `FillAlpha` - Sets the transparency of the box fill
766-
/// * `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
767-
/// previously set box width, or be set to the spacing of the boxes
766+
/// * `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
767+
/// previously set box width, or be set to the spacing of the boxes
768768
pub fn box_error_low_high<
769769
'l,
770770
Tx: DataType,
@@ -813,8 +813,8 @@ impl Axes2D
813813
/// * `Color` - Sets the color of the box fill
814814
/// * `FillAlpha` - Sets the transparency of the box fill
815815
/// * `WhiskerBars` - Sets the width of the whisker bars
816-
/// * `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
817-
/// previously set box width, or be set to the spacing of the boxes
816+
/// * `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
817+
/// previously set box width, or be set to the spacing of the boxes
818818
pub fn box_and_whisker<
819819
'l,
820820
Tx: DataType,
@@ -926,11 +926,11 @@ impl Axes2D
926926
///
927927
/// #Arguments:
928928
/// * `mat` - Row-major 2D array signifying the value of the datapoints. The X and Y coordinates of the datapoints are determined automatically,
929-
/// and optionally scaled using the `dimensions` argument.
929+
/// and optionally scaled using the `dimensions` argument.
930930
/// * `num_rows` - Number of rows in the data array
931931
/// * `num_cols` - Number of columns in the data array
932932
/// * `dimensions` - Optional X and Y coordinates of the first and last data points (with the rest of the coordinates spaced evenly between).
933-
/// By default this will be `(0, 0)` and `(num_rows - 1, num_cols - 1)`.
933+
/// By default this will be `(0, 0)` and `(num_rows - 1, num_cols - 1)`.
934934
/// * `options` - Array of PlotOption<&str> controlling the appearance of the surface. Relevant options are:
935935
/// * `Caption` - Specifies the caption for this dataset. Use an empty string to hide it (default).
936936
pub fn image<'l, T: DataType, X: IntoIterator<Item = T>>(

gnuplot/src/axes3d.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ impl Axes3D
7373
///
7474
/// #Arguments:
7575
/// * `mat` - Row-major 2D array signifying the Z coordinate of the datapoints. The X and Y coordinates of the datapoints are determined automatically,
76-
/// and optionally scaled using the `dimensions` argument.
76+
/// and optionally scaled using the `dimensions` argument.
7777
/// * `num_rows` - Number of rows in the data array
7878
/// * `num_cols` - Number of columns in the data array
7979
/// * `dimensions` - Optional X and Y coordinates of the first and last data points (with the rest of the coordinates spaced evenly between).
80-
/// By default this will be `(0, 0)` and `(num_rows - 1, num_cols - 1)`.
80+
/// By default this will be `(0, 0)` and `(num_rows - 1, num_cols - 1)`.
8181
/// * `options` - Array of PlotOption controlling the appearance of the surface. Relevant options are:
8282
/// * `Caption` - Specifies the caption for this dataset. Use an empty string to hide it (default).
8383
pub fn surface<'l, T: DataType, X: IntoIterator<Item = T>>(
@@ -345,9 +345,9 @@ impl Axes3D
345345
/// * `surface` - Show the contours on the surface itself
346346
/// * `style` - Style of the contours
347347
/// * `label` - Auto sets the label automatically and enables the legend, Fix() allows you specify a format string (using C style formatting),
348-
/// otherwise an empty string disables the legend and labels.
348+
/// otherwise an empty string disables the legend and labels.
349349
/// * `levels` - Auto picks some default number of levels, otherwise you can pass a set nominal number instead. The number is nominal as
350-
/// contours are placed at nice values of Z, and thus there may be fewer of them than this number.
350+
/// contours are placed at nice values of Z, and thus there may be fewer of them than this number.
351351
pub fn show_contours(
352352
&mut self, base: bool, surface: bool, style: ContourStyle, label: AutoOption<&str>,
353353
levels: AutoOption<u32>,
@@ -369,7 +369,7 @@ impl Axes3D
369369
/// * `surface` - Show the contours on the surface itself
370370
/// * `style` - Style of the contours
371371
/// * `label` - Auto sets the label automatically and enables the legend, Fix() allows you specify a format string (using C style formatting),
372-
/// otherwise an empty string disables the legend and labels.
372+
/// otherwise an empty string disables the legend and labels.
373373
/// * `levels` - A set of levels.
374374
pub fn show_contours_custom<T: DataType, TC: IntoIterator<Item = T>>(
375375
&mut self, base: bool, surface: bool, style: ContourStyle, label: AutoOption<&str>,

gnuplot/src/axes_common.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1372,7 +1372,7 @@ pub trait AxesCommon: AxesCommonPrivate
13721372
/// * `nrow` - Number of rows in the grid. Must be greater than 0.
13731373
/// * `ncol` - Number of columns in the grid. Must be greater than 0.
13741374
/// * `pos` - Which grid cell to place this axes in, counting from top-left corner,
1375-
/// going left and then down, starting at 0.
1375+
/// going left and then down, starting at 0.
13761376
fn set_pos_grid(&mut self, nrow: u32, ncol: u32, pos: u32) -> &mut Self
13771377
{
13781378
assert!(nrow > 0);
@@ -1417,7 +1417,7 @@ pub trait AxesCommon: AxesCommonPrivate
14171417
/// # Arguments
14181418
/// * `width` - Width of boxes.
14191419
/// * `is_relative` - if `true`, `width` is interpreted as a fraction of the default box width.
1420-
/// if `false` width is an absolute value in the units of the x axis
1420+
/// if `false` width is an absolute value in the units of the x axis
14211421
fn set_box_width(&mut self, width: f64, is_relative: bool) -> &mut Self
14221422
{
14231423
self.get_common_data_mut().box_width = Some((width, is_relative));
@@ -1539,9 +1539,9 @@ pub trait AxesCommon: AxesCommonPrivate
15391539
///
15401540
/// # Arguments
15411541
/// * `tick_placement` - Controls the placement of the ticks. Pass `None` to hide the ticks. Otherwise, the first tuple value controls the spacing
1542-
/// of the major ticks (in axes units), otherwise set it to `Auto` to let gnuplot decide the spacing automatically. The second
1543-
/// tuple value specifies the number of minor ticks. For logarithmic axes, non-zero values mean that the number of ticks usually
1544-
/// equals to `ceil(log_base) - 2`.
1542+
/// of the major ticks (in axes units), otherwise set it to `Auto` to let gnuplot decide the spacing automatically. The second
1543+
/// tuple value specifies the number of minor ticks. For logarithmic axes, non-zero values mean that the number of ticks usually
1544+
/// equals to `ceil(log_base) - 2`.
15451545
/// * `tick_options` - Array of TickOption controlling the appearance of the ticks
15461546
/// * `label_options` - Array of LabelOption<&str> controlling the appearance of the tick labels. Relevant options are:
15471547
/// * `Offset` - Specifies the offset of the label
@@ -1627,8 +1627,8 @@ pub trait AxesCommon: AxesCommonPrivate
16271627
/// # Arguments
16281628
///
16291629
/// * `ticks` - The locations and labels of the added ticks.
1630-
/// The label can contain a single C printf style floating point formatting specifier which will be replaced by the
1631-
/// location of the tic.
1630+
/// The label can contain a single C printf style floating point formatting specifier which will be replaced by the
1631+
/// location of the tic.
16321632
/// * `tick_options` - Array of TickOption controlling the appearance of the ticks
16331633
/// * `label_options` - Array of LabelOption<&str> controlling the appearance of the tick labels. Relevant options are:
16341634
/// * `Offset` - Specifies the offset of the label
@@ -2065,7 +2065,7 @@ pub trait AxesCommon: AxesCommonPrivate
20652065
/// # Arguments
20662066
///
20672067
/// * `margins` - The values of margins to be overriden. Specified as a fraction of the
2068-
/// full drawing area, ranging from 0 to 1
2068+
/// full drawing area, ranging from 0 to 1
20692069
fn set_margins(&mut self, margins: &[MarginSide]) -> &mut Self
20702070
{
20712071
{

gnuplot/src/color.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ pub enum ColorType<T = String>
3333
{
3434
/// string (`&str` or `String`, but usually created with `&str`) in one of the following gnuplot-supported formats
3535
/// - colorname --- e.g. "blue" [See the gnuplot
36-
/// [list of colornames](http://gnuplot.info/docs_6.0/loc11229.html)]
36+
/// [list of colornames](http://gnuplot.info/docs_6.0/loc11229.html)]
3737
/// - 0xRRGGBB --- string containing hexadecimal constant
3838
/// - 0xAARRGGBB --- string containing hexadecimal constant
3939
/// - #RRGGBB --- string containing hexadecimal in x11 format

0 commit comments

Comments
 (0)