Documentation fixes

melff · Nov 23, 2024 · 01fc487 · 01fc487
1 parent 9a8466e
commit 01fc487
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/pkg/R/widget-resizeable.R b/pkg/R/widget-resizeable.R
@@ -1,7 +1,10 @@
 #' Resizeable Widgets
 #' @description R6 classes of resizeable containers for arbitrary HTML code
+#' @details Support for resizeable widgets, available from 
+#'    \url{https://github.com/melff/resizeable-widget} (and hopefully soon from PyPi.org)
 #' @include widget-dom.R
 #' @name ResizeableWidget
+#' @keywords internal
 #' @export 
 ResizeableWidgetClass <- R6Class_(
   "ResizeableWidget",

diff --git a/pkg/R/widget-sidecar.R b/pkg/R/widget-sidecar.R
@@ -3,8 +3,9 @@ sidecar_module_version <- "1.1.0"
 
 #' Sidecar widgets
 #'
-#' @description Sidecar widgets - work only with Jupyter Lab
-#'
+#' @description Sidecar widgets - works only with Jupyter Lab
+#' @details Note that these widget need the sidecar extension for Jupyter Lab.
+#'      See \url{https://github.com/jupyter-widgets/jupyterlab-sidecar}
 #' @include widget-output.R
 #' @name Sidecar
 NULL

diff --git a/pkg/man/ResizeableWidget.Rd b/pkg/man/ResizeableWidget.Rd
diff --git a/pkg/man/Sidecar.Rd b/pkg/man/Sidecar.Rd