improve documentation

R/endpoint.R

@@ -7,10 +7,10 @@
 #' Dans le cas d'utilisation standard, la valeur de l'option `apinsee.url` est
 #' `"https://api.insee.fr/"`. Il n'est pas utile de la modifier sauf pour les
 #' agents de l'Insee qui souhaiteraient utiliser les plateformes de test, de
-#' recette ou de pré-production. Dans ce cas, il est préférable de déclarer
+#' recette ou de pré-production. Dans ce cas, afin de rendre les programmes
+#' portables d'un environnement à un autre.il est préférable de déclarer
 #' l'adresse en modifiant l'option `apinsee.url` :
-#' `options(apinsee.url = "<URL>")`. Les programmes seront ainsi facilement
-#' portables d'un environnement à un autre.
+#' `options(apinsee.url = "<URL>")`.
 #'
 #' @param insee_url Adresse du site fournissant les API. Ce paramètre n'est
 #'   utile que pour un usage interne à l'Insee, voir la section "Utilisation
@@ -21,6 +21,10 @@
 #' @encoding UTF-8
 #' @keywords internal
 #' @examples
+#' # Modify the following option to access to a different url
+#' # options(apinsee.url = "https://api.insee.fr/")
+#'
+#' library(apinsee)
 #' insee_endpoint()
 insee_endpoint <- function(insee_url = getOption("apinsee.url")) {
   httr::oauth_endpoint(

R/token.R

@@ -1,10 +1,10 @@
 #' @include endpoint.R
 NULL
 
-#' Generate a token for an Insee application
+#' Generate a valid token for an Insee application
 #'
-#' Cette fonction génère un jeton d'accès à une application créée sur le site
-#' [api.insee.fr](https://api.insee.fr/).
+#' Cette fonction génère un jeton d'accès valide à une application créée sur le
+#' site [api.insee.fr](https://api.insee.fr/).
 #'
 #' @inheritParams httr::oauth2.0_token
 #' @inheritParams insee_endpoint
@@ -60,17 +60,17 @@ insee_token <- function(
 #' Cette classe représente les jetons d'accès aux applications créées sur
 #' [api.insee.fr](https://api.insee.fr) et hérite de la classe
 #' [Token2.0][httr::Token-class] du package [httr][httr::httr-package]. Les
-#' objets de cette classe doivent être créés en appelant le constructeur
-#' `get_insee_token()`.
+#' objets de cette classe doivent être créés en utilisant le constructeur
+#' [insee_token()][insee_token].
 #'
 #' @format Un objet de classe `R6`.
 #' @section Methods:
 #' * `has_expired()` : le jeton d'accès a-t-il expiré ?
-#' * `cache()` : sauvegarde le jeton d'accès dans un cache
-#' * `revoke()` : révoque le jeton d'accès
+#' * `cache()` : sauvegarde le jeton d'accès dans un cache.
+#' * `revoke()` : révoque le jeton d'accès.
 #' * `refresh()` : rafraichit le jeton d'accès (le point d'accès de
 #' rafraichissement OAuth2 n'étant pas disponible, le jeton d'accès
-#' courant est révoqué puis un nouveau jeton d'accès est généré)
+#' courant est révoqué puis un nouveau jeton d'accès est généré).
 #' @inheritSection httr::Token Caching
 #' @docType class
 #' @keywords internal