Skip to content

Commit d4a2e3a

Browse files
committed
docs: Improve Toaster docs formatting
1 parent cd13c24 commit d4a2e3a

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

R/toaster.R

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ incrementToasterId <- createIdIncrementationFunction()
1212

1313
#' Toaster
1414
#'
15+
#' @description
1516
#' Documentation: <https://blueprintjs.com/docs/#core/components/toast>
17+
#'
1618
#' @export
1719
Toaster <- R6::R6Class(
1820
classname = "Toaster",
@@ -29,6 +31,7 @@ Toaster <- R6::R6Class(
2931
private$session <- session
3032
private$registerToaster(...)
3133
},
34+
3235
#' @description Shows a new toast to the user, or updates an existing toast
3336
#' corresponding to the provided key
3437
#' @param ... Parameters passed to `Toaster` component
@@ -43,13 +46,15 @@ Toaster <- R6::R6Class(
4346
)
4447
)
4548
},
49+
4650
#' @description Dismiss all toasts instantly
4751
clear = function() {
4852
private$session$sendCustomMessage(
4953
private$callName("clear"),
5054
list()
5155
)
5256
},
57+
5358
#' @description Dismiss the given toast instantly
5459
#' @param key A key of toast to be shown/dismissed
5560
dismiss = function(key) {

0 commit comments

Comments
 (0)