From a26c354f500c61501c6cc0e11e0016e283cdae4f Mon Sep 17 00:00:00 2001
From: Dorchies David <david.dorchies@inrae.fr>
Date: Fri, 6 Aug 2021 11:07:18 +0200
Subject: [PATCH] doc: comments in examples

---
 R/get_hydrometrie_observations_tr.R         | 2 +-
 R/get_hydrometrie_sites.R                   | 2 +-
 R/get_hydrometrie_stations.R                | 2 +-
 R/get_indicateurs_services_communes.R       | 2 +-
 R/get_indicateurs_services_indicateurs.R    | 2 +-
 R/get_prelevements_chroniques.R             | 2 +-
 R/get_prelevements_ouvrages.R               | 2 +-
 R/get_prelevements_points_prelevement.R     | 2 +-
 man/get_hydrometrie_observations_tr.Rd      | 2 +-
 man/get_hydrometrie_sites.Rd                | 2 +-
 man/get_hydrometrie_stations.Rd             | 2 +-
 man/get_indicateurs_services_communes.Rd    | 2 +-
 man/get_indicateurs_services_indicateurs.Rd | 2 +-
 man/get_prelevements_chroniques.Rd          | 2 +-
 man/get_prelevements_ouvrages.Rd            | 2 +-
 man/get_prelevements_points_prelevement.Rd  | 2 +-
 16 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/R/get_hydrometrie_observations_tr.R b/R/get_hydrometrie_observations_tr.R
index 6eaf4f2..5b5f262 100644
--- a/R/get_hydrometrie_observations_tr.R
+++ b/R/get_hydrometrie_observations_tr.R
@@ -8,7 +8,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the hydrometric last real time observed discharge at station 'H020302002'
+#' # Retrieve the hydrometric last real time observed discharge at station 'H020302002'
 #' get_hydrometrie_observations_tr(list(code_entite = "H0203020", grandeur_hydro = "Q"))
 #'
 get_hydrometrie_observations_tr  <- function(params,
diff --git a/R/get_hydrometrie_sites.R b/R/get_hydrometrie_sites.R
index 99deb37..1dbc1f0 100644
--- a/R/get_hydrometrie_sites.R
+++ b/R/get_hydrometrie_sites.R
@@ -9,7 +9,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the hydrometric sites in the department of Aube
+#' # Retrieve the hydrometric sites in the department of Aube
 #' get_hydrometrie_sites(list(code_departement = "10"))
 #'
 #' # The same operation returning 2 rows for the site 'H0203020' which has 2 different locations
diff --git a/R/get_hydrometrie_stations.R b/R/get_hydrometrie_stations.R
index fd4286a..d00b0f7 100644
--- a/R/get_hydrometrie_stations.R
+++ b/R/get_hydrometrie_stations.R
@@ -9,7 +9,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the hydrometric stations in the department of Aube
+#' # Retrieve the hydrometric stations in the department of Aube
 #' get_hydrometrie_stations(list(code_departement = "10"))
 #'
 get_hydrometrie_stations  <- function(params, code_sandre_reseau_station = FALSE, cfg = config::get(file = system.file("config.yml",
diff --git a/R/get_indicateurs_services_communes.R b/R/get_indicateurs_services_communes.R
index 7cb17c8..0353691 100644
--- a/R/get_indicateurs_services_communes.R
+++ b/R/get_indicateurs_services_communes.R
@@ -15,7 +15,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving performance indicator time series of the services in Romilly-sur-Seine
+#' # Retrieve performance indicator time series of the services in Romilly-sur-Seine
 #' get_indicateurs_services_communes(list(code_commune = "10323"))
 #'
 get_indicateurs_services_communes <- function(params,
diff --git a/R/get_indicateurs_services_indicateurs.R b/R/get_indicateurs_services_indicateurs.R
index 675a06a..828fc16 100644
--- a/R/get_indicateurs_services_indicateurs.R
+++ b/R/get_indicateurs_services_indicateurs.R
@@ -15,7 +15,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the withdrawal time series of the devices located in Romilly-sur-Seine
+#' # Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
 #' get_indicateurs_services_indicateurs(list(code_indicateur = "D102.0", annee = "2012"))
 #'
 get_indicateurs_services_indicateurs <- function(params,
diff --git a/R/get_prelevements_chroniques.R b/R/get_prelevements_chroniques.R
index 9a7983f..a94db6f 100644
--- a/R/get_prelevements_chroniques.R
+++ b/R/get_prelevements_chroniques.R
@@ -8,7 +8,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the withdrawal time series of the devices located in Romilly-sur-Seine
+#' # Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
 #' get_prelevements_chroniques(list(code_commune_insee = "10323"))
 #'
 get_prelevements_chroniques <- function(params, cfg = config::get(file = system.file("config.yml",
diff --git a/R/get_prelevements_ouvrages.R b/R/get_prelevements_ouvrages.R
index 46c7e02..6d44579 100644
--- a/R/get_prelevements_ouvrages.R
+++ b/R/get_prelevements_ouvrages.R
@@ -8,7 +8,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the withdrawal devices located in Romilly-sur-Seine
+#' # Retrieve the withdrawal devices located in Romilly-sur-Seine
 #' get_prelevements_ouvrages(list(code_commune_insee = "10323"))
 #'
 get_prelevements_ouvrages <- function(params, cfg = config::get(file = system.file("config.yml",
diff --git a/R/get_prelevements_points_prelevement.R b/R/get_prelevements_points_prelevement.R
index b23b314..c9d5c93 100644
--- a/R/get_prelevements_points_prelevement.R
+++ b/R/get_prelevements_points_prelevement.R
@@ -8,7 +8,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the withdrawal points located in Romilly-sur-Seine
+#' # Retrieve the withdrawal points located in Romilly-sur-Seine
 #' get_prelevements_points_prelevement(list(code_commune_insee = "10323"))
 #'
 get_prelevements_points_prelevement <- function(params, cfg = config::get(file = system.file("config.yml",
diff --git a/man/get_hydrometrie_observations_tr.Rd b/man/get_hydrometrie_observations_tr.Rd
index 2c90cd4..03509eb 100644
--- a/man/get_hydrometrie_observations_tr.Rd
+++ b/man/get_hydrometrie_observations_tr.Rd
@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
 }
 \examples{
-# For retrieving the hydrometric last real time observed discharge at station 'H020302002'
+# Retrieve the hydrometric last real time observed discharge at station 'H020302002'
 get_hydrometrie_observations_tr(list(code_entite = "H0203020", grandeur_hydro = "Q"))
 
 }
diff --git a/man/get_hydrometrie_sites.Rd b/man/get_hydrometrie_sites.Rd
index 07086d2..61130ff 100644
--- a/man/get_hydrometrie_sites.Rd
+++ b/man/get_hydrometrie_sites.Rd
@@ -25,7 +25,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
 }
 \examples{
-# For retrieving the hydrometric sites in the department of Aube
+# Retrieve the hydrometric sites in the department of Aube
 get_hydrometrie_sites(list(code_departement = "10"))
 
 # The same operation returning 2 rows for the site 'H0203020' which has 2 different locations
diff --git a/man/get_hydrometrie_stations.Rd b/man/get_hydrometrie_stations.Rd
index 029f6b8..d4c677f 100644
--- a/man/get_hydrometrie_stations.Rd
+++ b/man/get_hydrometrie_stations.Rd
@@ -25,7 +25,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
 }
 \examples{
-# For retrieving the hydrometric stations in the department of Aube
+# Retrieve the hydrometric stations in the department of Aube
 get_hydrometrie_stations(list(code_departement = "10"))
 
 }
diff --git a/man/get_indicateurs_services_communes.Rd b/man/get_indicateurs_services_communes.Rd
index 6f2e463..04251fb 100644
--- a/man/get_indicateurs_services_communes.Rd
+++ b/man/get_indicateurs_services_communes.Rd
@@ -29,7 +29,7 @@ a \link[tibble:tibble]{tibble::tibble} with one row by commune, by service and b
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
 }
 \examples{
-# For retrieving performance indicator time series of the services in Romilly-sur-Seine
+# Retrieve performance indicator time series of the services in Romilly-sur-Seine
 get_indicateurs_services_communes(list(code_commune = "10323"))
 
 }
diff --git a/man/get_indicateurs_services_indicateurs.Rd b/man/get_indicateurs_services_indicateurs.Rd
index 1c03ef9..9c96ae2 100644
--- a/man/get_indicateurs_services_indicateurs.Rd
+++ b/man/get_indicateurs_services_indicateurs.Rd
@@ -29,7 +29,7 @@ a \link[tibble:tibble]{tibble::tibble} with one row by commune, by service and b
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
 }
 \examples{
-# For retrieving the withdrawal time series of the devices located in Romilly-sur-Seine
+# Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
 get_indicateurs_services_indicateurs(list(code_indicateur = "D102.0", annee = "2012"))
 
 }
diff --git a/man/get_prelevements_chroniques.Rd b/man/get_prelevements_chroniques.Rd
index 3fac8cd..3f1b8cc 100644
--- a/man/get_prelevements_chroniques.Rd
+++ b/man/get_prelevements_chroniques.Rd
@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
 }
 \examples{
-# For retrieving the withdrawal time series of the devices located in Romilly-sur-Seine
+# Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
 get_prelevements_chroniques(list(code_commune_insee = "10323"))
 
 }
diff --git a/man/get_prelevements_ouvrages.Rd b/man/get_prelevements_ouvrages.Rd
index 7925b6a..80f51d9 100644
--- a/man/get_prelevements_ouvrages.Rd
+++ b/man/get_prelevements_ouvrages.Rd
@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
 }
 \examples{
-# For retrieving the withdrawal devices located in Romilly-sur-Seine
+# Retrieve the withdrawal devices located in Romilly-sur-Seine
 get_prelevements_ouvrages(list(code_commune_insee = "10323"))
 
 }
diff --git a/man/get_prelevements_points_prelevement.Rd b/man/get_prelevements_points_prelevement.Rd
index efea333..3c76aac 100644
--- a/man/get_prelevements_points_prelevement.Rd
+++ b/man/get_prelevements_points_prelevement.Rd
@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau#/prelevements/prelevement}
 }
 \examples{
-# For retrieving the withdrawal points located in Romilly-sur-Seine
+# Retrieve the withdrawal points located in Romilly-sur-Seine
 get_prelevements_points_prelevement(list(code_commune_insee = "10323"))
 
 }
-- 
GitLab