From 45b2b7d881a32e8e22309d698f0168a78ffeaafd Mon Sep 17 00:00:00 2001 From: Hadley Wickham Date: Wed, 2 Oct 2024 07:50:32 -0500 Subject: [PATCH] Update cross references --- documentation.qmd | 2 +- files.qmd | 2 +- news.qmd | 2 +- package-files.qmd | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation.qmd b/documentation.qmd index b997f2f..736364f 100644 --- a/documentation.qmd +++ b/documentation.qmd @@ -1,4 +1,4 @@ -# Documentation +# Documentation {#sec-documentation} ## Introduction diff --git a/files.qmd b/files.qmd index ba7f9f4..519c055 100755 --- a/files.qmd +++ b/files.qmd @@ -1,4 +1,4 @@ -# Files +# Files {#sec-files} ## Names diff --git a/news.qmd b/news.qmd index a4c1c87..36ae40f 100644 --- a/news.qmd +++ b/news.qmd @@ -6,7 +6,7 @@ Each user-facing change to a package should be accompanied by a bullet in `NEWS. The goal of the bullet is to briefly describe the change so users of the packages can understand what's changed. This can be similar to the commit message, but written with a user (not developer) in mind. It's worth emphasizing this point --- the reader of your NEWS entries is likely unfamiliar with the day-to-day development work or internals of your package. Think carefully about how to concisely but clearly summarize what's changed and why it matters for them. If it doesn't matter (i.e. it's a purely internal change), you don't need a bullet. -New bullets should be added to the top of the file (immediately under the first heading) and should be a single line. Organisation and wrapping will happen later, during the release process (Section \@ref(news-release)). +New bullets should be added to the top of the file (immediately under the first heading) and should be a single line. Organisation and wrapping will happen later, during the release process. ``` # haven (development version) diff --git a/package-files.qmd b/package-files.qmd index 9c33e53..798dc44 100644 --- a/package-files.qmd +++ b/package-files.qmd @@ -1,6 +1,6 @@ # Files {#package-files} -The majority of advice in Chapter \@ref(files) also applies to files in packages. Important differences are described below. +The majority of advice in @sec-files also applies to files in packages. Important differences are described below. ## Names @@ -19,7 +19,7 @@ documentation should appear first, with private functions appearing after all documented functions. If multiple public functions share the same documentation, they should all immediately follow the documentation block. -See \@ref(documentation) for more thorough guidance on documenting functions +See @sec-documentation for more thorough guidance on documenting functions in packages. ```{r}