Sharpen doc

imanuelcostigan · Sep 7, 2019 · 37fe2d1 · 37fe2d1
1 parent 5c4a1b5
commit 37fe2d1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/R/vol-surface-class.R b/R/vol-surface-class.R
@@ -6,15 +6,15 @@
 #' @param vol_quotes object of class [VolQuotes()] containing the volatility
 #'   data.
 #' @param interpolation Interplation method, given as an object of class
-#'   interpolation [Interpolation()]. At this time only the
+#'   interpolation [Interpolation()]. At this time only
 #'   [LinearCubicTimeVarInterpolation()] is supported. This is a two-dimensional
 #'   interpolator that uses linear interpolation in the time dimension and cubic
 #'   splines in the smile dimension with the values interpolated being the
 #'   square of the implied volatilities. Return values are implied volatilies
 #' @return a `VolSurface` object
 #' @seealso [interpolate.VolSurface], [build_vol_surface()]
 #' @examples
-#' build_vol_surface()
+#' VolSurface(build_vol_quotes(), LinearCubicTimeVarInterpolation())
 #' @export
 
 VolSurface <- function(vol_quotes, interpolation) {

diff --git a/man/VolSurface.Rd b/man/VolSurface.Rd