Skip to content

docs: add more about igraph.r2cdocs in the contributing guide #1697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maelle merged 1 commit into from
Feb 19, 2025
Merged

docs: add more about igraph.r2cdocs in the contributing guide #1697

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down