Skip to content

doc API some fields a bit more #103

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
merged 2 commits into from
Jul 16, 2025
Merged

doc API some fields a bit more #103

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fad883f
doc API some fields a bit more
maelle Jul 16, 2025
f5e656d
Update api.qmd
maelle Jul 16, 2025
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
5 changes: 5 additions & 0 deletions browse/api.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ str(packages[[1]], max.level = 1)

URL: `https://<username>.r-universe.dev/api/packages/<package>`

Fields that start with an underscore `_`, like `_topics`, are not present in the `DESCRIPTION` file.
Note that some fields that do **not** start with an underscore (the fields `Repository`, `RemoteUrl`, `RemoteRef` and `RemoteSha`) get automatically inserted in the DESCRIPTION file by our build system.
These same fields would be added automatically if you install a package using for instance `install_github()`.
The main purpose is that for instance the renv package will know where to find the source for the package, if it needs to pin an exact version.

Example using `{httr2}`:

```{r}
Expand Down