diff --git a/src/RescriptReactErrorBoundary.res b/src/RescriptReactErrorBoundary.res index 3caa0e8..cb00d25 100644 --- a/src/RescriptReactErrorBoundary.res +++ b/src/RescriptReactErrorBoundary.res @@ -1,8 +1,8 @@ -@ocaml.doc(" +/*** * Important note on this module: * As soon as React provides a mechanism for error-catching using functional component, * this is likely to be deprecated and/or move to user space. - ") + */ type info = {componentStack: string} type params<'error> = { diff --git a/src/RescriptReactErrorBoundary.resi b/src/RescriptReactErrorBoundary.resi index 3bc8071..0ebdbc8 100644 --- a/src/RescriptReactErrorBoundary.resi +++ b/src/RescriptReactErrorBoundary.resi @@ -1,8 +1,8 @@ -@ocaml.doc(" +/*** * Important note on this module: * As soon as React provides a mechanism for error-catching using functional component, * this is likely to be deprecated and/or move to user space. - ") + */ type info = {componentStack: string} type params<'error> = { diff --git a/src/RescriptReactRouter.resi b/src/RescriptReactRouter.resi index 654235e..25357f3 100644 --- a/src/RescriptReactRouter.resi +++ b/src/RescriptReactRouter.resi @@ -1,11 +1,7 @@ -@ocaml.doc( - "update the url with the string path. Example: `push(\"/book/1\")`, `push(\"/books#title\")` " -) +/** update the url with the string path. Example: `push(\"/book/1\")`, `push(\"/books#title\")` */ let push: string => unit -@ocaml.doc( - "update the url with the string path. modifies the current history entry instead of creating a new one. Example: `replace(\"/book/1\")`, `replace(\"/books#title\")` " -) +/** update the url with the string path. modifies the current history entry instead of creating a new one. Example: `replace(\"/book/1\")`, `replace(\"/books#title\")` */ let replace: string => unit type watcherID type url = { @@ -17,15 +13,13 @@ type url = { search: string, } -@ocaml.doc( - "start watching for URL changes. Returns a subscription token. Upon url change, calls the callback and passes it the url record " -) +/** start watching for URL changes. Returns a subscription token. Upon url change, calls the callback and passes it the url record */ let watchUrl: (url => unit) => watcherID -@ocaml.doc(" stop watching for URL changes ") +/** stop watching for URL changes */ let unwatchUrl: watcherID => unit -@ocaml.doc("this is marked as \"dangerous\" because you technically shouldn't +/** this is marked as \"dangerous\" because you technically shouldn't be accessing the URL outside of watchUrl's callback; you'd read a potentially stale url, instead of the fresh one inside watchUrl. @@ -37,10 +31,10 @@ let unwatchUrl: watcherID => unit So, the correct (and idiomatic) usage of this helper is to only use it in a component that's also subscribed to watchUrl. Please see https://github.com/reasonml-community/reason-react-example/blob/master/src/todomvc/TodoItem.re - for an example.") + for an example. */ let dangerouslyGetInitialUrl: (~serverUrlString: string=?, unit) => url -@ocaml.doc("hook for watching url changes. +/** hook for watching url changes. * serverUrl is used for ssr. it allows you to specify the url without relying on browser apis existing/working as expected - ") + */ let useUrl: (~serverUrl: url=?, unit) => url