Skip to content

Commit 44f2343

Browse files
Merge pull request #420 from SciML/os/remove-from-docs
remove kwargs from docs
2 parents 799a2bc + 838d529 commit 44f2343

File tree

2 files changed

+1
-37
lines changed

2 files changed

+1
-37
lines changed

README.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -76,24 +76,6 @@ The follow methods require extra dependencies and will be loaded as package exte
7676

7777
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.
7878

79-
The series types defined are:
80-
81-
- `:linear_interp`
82-
- `:quadratic_interp`
83-
- `:lagrange_interp`
84-
- `:quadratic_spline`
85-
- `:cubic_spline`
86-
- `:akima_interp`
87-
- `:bspline_interp`
88-
- `:bspline_approx`
89-
- `:cubic_hermite_spline`
90-
- `:pchip_interp`
91-
- `:quintic_hermite_spline`
92-
93-
By and large, these accept the same keywords as their function counterparts.
94-
95-
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.
96-
9779
## Citing
9880

9981
If you use this software in your work, please cite:

docs/src/index.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,25 +44,7 @@ The following methods require extra dependencies and will be loaded as package e
4444

4545
## Plotting
4646

47-
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.
48-
49-
The series types defined are:
50-
51-
- `:linear_interp`
52-
- `:quadratic_interp`
53-
- `:lagrange_interp`
54-
- `:quadratic_spline`
55-
- `:cubic_spline`
56-
- `:akima_interp`
57-
- `:bspline_interp`
58-
- `:bspline_approx`
59-
- `:cubic_hermite_spline`
60-
- `:pchip_interp`
61-
- `:quintic_hermite_spline`
62-
63-
By and large, these accept the same keywords as their function counterparts.
64-
65-
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.
47+
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.
6648

6749
## Citing
6850

0 commit comments

Comments
 (0)