From f9c797dace6c4f6391411e938bccece5aa7c81e6 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 13 Sep 2026 14:19:54 +0000 Subject: [PATCH] docs: Attach the "How to use the data sets" section to the package page The section documented nothing. Two blank lines separated its roxygen block from the `NULL` below it, so roxygen2 ended the block at the gap and found no object to attach it to, and dropped it without a word. `@section` also requires a trailing colon after the title, which it did not have. Neither mistake produces a warning; the text simply never reached `man/igraphdata-package.Rd`. It is moved into the `"_PACKAGE"` block at the top of the file, which is where package-level documentation belongs and where it now renders -- `tools::Rd2txt()` shows the section between Description and Author(s). The prose is unchanged. Found while reformatting this file for line breaks; it is a separate change because it alters rendered output, which that pass does not. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m --- R/igraphdata-package.R | 9 ++++----- man/igraphdata-package.Rd | 9 +++++++++ 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/R/igraphdata-package.R b/R/igraphdata-package.R index 6d4462c..8d5d5cc 100644 --- a/R/igraphdata-package.R +++ b/R/igraphdata-package.R @@ -1,13 +1,12 @@ -#' @keywords internal -"_PACKAGE" - -#' @section How to use the data sets +#' @section How to use the data sets: #' After loading the \pkg{igraphdata} package, the various data sets are available #' by accessing them directly. #' #' Get a list of data sets included in this package with #' `data(package = "igraphdata")`. - +#' +#' @keywords internal +"_PACKAGE" ## usethis namespace: start #' @importFrom igraph vcount diff --git a/man/igraphdata-package.Rd b/man/igraphdata-package.Rd index a28dfaa..47e74c6 100644 --- a/man/igraphdata-package.Rd +++ b/man/igraphdata-package.Rd @@ -8,6 +8,15 @@ \description{ A small collection of various network data sets, to use with the 'igraph' package: the Enron email network, various food webs, interactions in the immunoglobulin protein, the karate club network, Koenigsberg's bridges, visuotactile brain areas of the macaque monkey, UK faculty friendship network, domestic US flights network, etc. Also provides access to the API of \url{https://networks.skewed.de/}. } +\section{How to use the data sets}{ + +After loading the \pkg{igraphdata} package, the various data sets are available +by accessing them directly. + +Get a list of data sets included in this package with +\code{data(package = "igraphdata")}. +} + \seealso{ Useful links: \itemize{