Skip to content

Commit

Permalink
Update cross references
Browse files Browse the repository at this point in the history
  • Loading branch information
hadley committed Oct 2, 2024
1 parent bd71a46 commit 45b2b7d
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion documentation.qmd
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Documentation
# Documentation {#sec-documentation}

## Introduction

Expand Down
2 changes: 1 addition & 1 deletion files.qmd
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Files
# Files {#sec-files}

## Names

Expand Down
2 changes: 1 addition & 1 deletion news.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions package-files.qmd
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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}
Expand Down

0 comments on commit 45b2b7d

Please sign in to comment.