From dbbd4503d803cadc20ec5fe348695117e0fb0feb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Wed, 19 Feb 2025 16:54:37 +0100 Subject: [PATCH] docs: add more about igraph.r2cdocs in the contributing guide --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e40b8a32d24..4bf2d341270 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -154,6 +154,16 @@ pak::pak("igraph/igraph.r2cdocs") [roxygen2](https://roxygen2.r-lib.org/), and run `devtools::document()` or `make igraph` to update the `.Rd` files. +- Links to C docs are added using the cdocs tag, for instance: + +``` +#' @cdocs igraph_assortativity +``` + +### Maintaining igraph.r2cdocs + +To update the data (when the C docs index has changed after a release) in https://github.com/igraph/igraph.r2cdocs/, run the script that is `data-raw`, commit the csv file and push. + ### Test Cases Unless you change something trivial, please consider adding test cases. This is