Skip to content

Plot: Improve AxisAuto XML docs #1367

@swharden

Description

@swharden

It's not obvious to new users that the axis index arguments are only required for plots with multiple X and Y axes (#1366)

/// <summary>
/// Automatically adjust axis limits to fit the data
/// </summary>
/// <param name="horizontalMargin">amount of space to the left and right of the data (as a fraction of its width)</param>
/// <param name="verticalMargin">amount of space above and below the data (as a fraction of its height)</param>
/// <param name="xAxisIndex">only modify the given axis (otherwise all axes will be adjusted)</param>
/// <param name="yAxisIndex">only modify the given axis (otherwise all axes will be adjusted)</param>
public void AxisAuto(double? horizontalMargin = null, double? verticalMargin = null, int? xAxisIndex = null, int? yAxisIndex = null)

AxisAutoX and AxisAutoY also have poorly written XML docs

/// <summary>
/// Automatically adjust axis limits to fit the data
/// </summary>
/// <param name="margin">amount of space to the left and right of the data (as a fraction of its width)</param>
public void AxisAutoX(double margin = .05)

/// <summary>
/// Automatically adjust axis limits to fit the data (with a little extra margin)
/// </summary>
/// <param name="margin">amount of space above and below the data (as a fraction of its height)</param>
public void AxisAutoY(double margin = .1)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions