From 98dc44f40fe90f378dcc3eda302fb8a93894855e Mon Sep 17 00:00:00 2001
From: Dorchies David <david.dorchies@inrae.fr>
Date: Fri, 30 Apr 2021 16:49:35 +0200
Subject: [PATCH] doc(doQuery): correction and cleaning
---
R/doQuery.R | 4 ++--
man-roxygen/param_cfg_cookie.R | 2 --
man/doQuery.Rd | 6 +++---
3 files changed, 5 insertions(+), 7 deletions(-)
delete mode 100644 man-roxygen/param_cfg_cookie.R
diff --git a/R/doQuery.R b/R/doQuery.R
index c4c12ea..fa52508 100644
--- a/R/doQuery.R
+++ b/R/doQuery.R
@@ -1,7 +1,7 @@
-#' Internal function for doing the queries
+#' Internal function for doing the queries for the bnpe package
#'
#' @param url_path the end of the URL path
-#' @param params A list containing the parameters sent in the query. [character] Name of the geographical identifier ("insee_com", "code_dep"...)
+#' @param params A list containing the parameters sent in the query
#' @inheritParams getCookie
#' @param cookie a named [character] [vector] with the values of the cookies (See [getCookie])
#'
diff --git a/man-roxygen/param_cfg_cookie.R b/man-roxygen/param_cfg_cookie.R
deleted file mode 100644
index b1d7202..0000000
--- a/man-roxygen/param_cfg_cookie.R
+++ /dev/null
@@ -1,2 +0,0 @@
-#' @param cookie a named [character] [vector] with the values of the cookies (See [getCookie])
-#' @inheritParams getCookie
diff --git a/man/doQuery.Rd b/man/doQuery.Rd
index d8056d9..0ad7f03 100644
--- a/man/doQuery.Rd
+++ b/man/doQuery.Rd
@@ -2,7 +2,7 @@
% Please edit documentation in R/doQuery.R
\name{doQuery}
\alias{doQuery}
-\title{Internal function for doing the queries}
+\title{Internal function for doing the queries for the bnpe package}
\usage{
doQuery(
url_path,
@@ -15,7 +15,7 @@ doQuery(
\arguments{
\item{url_path}{the end of the URL path}
-\item{params}{A list containing the parameters sent in the query. \link{character} Name of the geographical identifier ("insee_com", "code_dep"...)}
+\item{params}{A list containing the parameters sent in the query}
\item{cfg}{a \link{config} object Configuration of the communication. Use by default the internal package
configuration stored at location \code{system.file("config.yml", package = "bnpe")}}
@@ -26,5 +26,5 @@ configuration stored at location \code{system.file("config.yml", package = "bnpe
a \link[httr:response]{httr::response} object from a \link[httr:GET]{httr::GET}
}
\description{
-Internal function for doing the queries
+Internal function for doing the queries for the bnpe package
}
--
GitLab