docs(README): update description of API qualite_rivieres

Refs #9
inrae · Feb 22, 2024 · a66afa2 · a66afa2
1 parent 4430238
commit a66afa2
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -154,13 +154,17 @@ API documentation:
 Available functions:
 
 - [`get_qualite_rivieres_station`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html):
-  measuring stations for river quality
+  stations (measuring points) on rivers or water bodies where water
+  samples have been taken for water quality analyses
 - [`get_qualite_rivieres_operation`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html):
-  physico-chemical operations
+  sampling operations carried out at the stations
 - [`get_qualite_rivieres_analyse`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html):
-  results of physico-chemical analyses
+  physico-chemical analyses carried out on samples prepared during
+  sampling operations at the stations
 - [`get_qualite_rivieres_condition_environnementale`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html):
-  environmental conditions for analyses
+  environmental conditions (air temperature, presence of leaves, moss,
+  iridescence, etc.) observed during physico-chemical sampling
+  operations
 
 ## API “Qualité des nappes d’eau souterraines”
 

diff --git a/man-roxygen/hubeau.md b/man-roxygen/hubeau.md
@@ -82,10 +82,10 @@ API documentation: <https://hubeau.eaufrance.fr/page/api-qualite-cours-deau>
 
 Available functions:
 
-- [get_qualite_rivieres_station()]: measuring stations for river quality
-- [get_qualite_rivieres_operation()]: physico-chemical operations
-- [get_qualite_rivieres_analyse()]: results of physico-chemical analyses
-- [get_qualite_rivieres_condition_environnementale()]: environmental conditions for analyses
+- [get_qualite_rivieres_station()]: stations (measuring points) on rivers or water bodies where water samples have been taken for water quality analyses
+- [get_qualite_rivieres_operation()]: sampling operations carried out at the stations
+- [get_qualite_rivieres_analyse()]: physico-chemical analyses carried out on samples prepared during sampling operations at the stations
+- [get_qualite_rivieres_condition_environnementale()]: environmental conditions (air temperature, presence of leaves, moss, iridescence, etc.) observed during physico-chemical sampling operations
 
 ## API "Qualité des nappes d'eau souterraines"
 

diff --git a/man/hubeau.Rd b/man/hubeau.Rd