Skip to content

remove kwargs from docs #420

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.

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
Apr 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 0 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,6 @@ The follow methods require extra dependencies and will be loaded as package exte

DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase. Any interpolation can be plotted using the `plot` command (or any other), since they have type recipes associated with them. For convenience, and to allow keyword arguments to propagate properly, DataInterpolations.jl also defines several series types, corresponding to different interpolations.

The series types defined are:

- `:linear_interp`
- `:quadratic_interp`
- `:lagrange_interp`
- `:quadratic_spline`
- `:cubic_spline`
- `:akima_interp`
- `:bspline_interp`
- `:bspline_approx`
- `:cubic_hermite_spline`
- `:pchip_interp`
- `:quintic_hermite_spline`

By and large, these accept the same keywords as their function counterparts.

Some keywords differ from regular plots. `label_interp` is used to label the interpolation line plot, while `label_data` labels the data points. By default, both are plotted in the same color.

## Citing

If you use this software in your work, please cite:
Expand Down
20 changes: 1 addition & 19 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,25 +44,7 @@ The following methods require extra dependencies and will be loaded as package e

## Plotting

DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase. Any interpolation can be plotted using the `plot` command (or any other), since they have type recipes associated with them. For convenience, and to allow keyword arguments to propagate properly, DataInterpolations.jl also defines several series types, corresponding to different interpolations.

The series types defined are:

- `:linear_interp`
- `:quadratic_interp`
- `:lagrange_interp`
- `:quadratic_spline`
- `:cubic_spline`
- `:akima_interp`
- `:bspline_interp`
- `:bspline_approx`
- `:cubic_hermite_spline`
- `:pchip_interp`
- `:quintic_hermite_spline`

By and large, these accept the same keywords as their function counterparts.

Some keywords differ from regular plots. `label_interp` is used to label the interpolation line plot, while `label_data` labels the data points. By default, both are plotted in the same color.
DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase. Any interpolation can be plotted using the `plot` command (or any other), since they have type recipes associated with them.

## Citing

Expand Down
Loading