Skip to content

Commit c9cfe2f

Browse files
committed
Deploying to gh-pages from @ df5fa41 🚀
1 parent 891c4eb commit c9cfe2f

10 files changed

Lines changed: 240 additions & 5 deletions

File tree

index.html

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,14 @@ This is a basic example which shows you how to solve a common problem:
5656
``` r
5757

5858
library(glossary)
59-
## basic example code
59+
current_glossary <- data.frame()
60+
updated_glossary <- update_glossary(
61+
glossary = current_glossary,
62+
english = "data frame",
63+
spanish = "marco de datos",
64+
updated_via = "GitHub",
65+
weblate = "include"
66+
)
6067
```
6168
6269
## Contributors

llms.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,14 @@ This is a basic example which shows you how to solve a common problem:
5656
``` r
5757

5858
library(glossary)
59-
## basic example code
59+
current_glossary <- data.frame()
60+
updated_glossary <- update_glossary(
61+
glossary = current_glossary,
62+
english = "data frame",
63+
spanish = "marco de datos",
64+
updated_via = "GitHub",
65+
weblate = "include"
66+
)
6067
```
6168

6269
## Contributors
@@ -84,4 +91,6 @@ specification. Contributions of any kind are welcome!
8491
: Get the rOpenSci glossary
8592
- [`get_weblate_glossary()`](http://contributor.r-project.org/glossary/reference/get_weblate_glossary.md)
8693
: Get the Weblate glossary
94+
- [`update_glossary()`](http://contributor.r-project.org/glossary/reference/update_glossary.md)
95+
: Update a glossary entry
8796

pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ pandoc: 3.8.3
22
pkgdown: 2.2.1
33
pkgdown_sha: ~
44
articles: {}
5-
last_built: 2026-09-03T13:19Z
5+
last_built: 2026-09-03T13:34Z
66
urls:
77
reference: http://contributor.r-project.org/glossary/reference
88
article: http://contributor.r-project.org/glossary/articles

reference/index.html

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

reference/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@
88
: Get the rOpenSci glossary
99
- [`get_weblate_glossary()`](http://contributor.r-project.org/glossary/reference/get_weblate_glossary.md)
1010
: Get the Weblate glossary
11+
- [`update_glossary()`](http://contributor.r-project.org/glossary/reference/update_glossary.md)
12+
: Update a glossary entry

reference/update_glossary.html

Lines changed: 131 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

reference/update_glossary.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Update a glossary entry
2+
3+
Adds a new glossary entry or updates an existing entry in a glossary
4+
data frame.
5+
6+
## Usage
7+
8+
``` r
9+
update_glossary(
10+
glossary,
11+
english,
12+
spanish,
13+
synonym = NA_character_,
14+
observation = NA_character_,
15+
updated_via = c("GitHub", "Weblate"),
16+
weblate = NA_character_
17+
)
18+
```
19+
20+
## Arguments
21+
22+
- glossary:
23+
24+
A glossary data frame.
25+
26+
- english:
27+
28+
A character string containing the English term.
29+
30+
- spanish:
31+
32+
A character string containing the Spanish translation.
33+
34+
- synonym:
35+
36+
An optional character string containing a synonym.
37+
38+
- observation:
39+
40+
An optional character string containing additional observations.
41+
42+
- updated_via:
43+
44+
Where the entry was updated. Either `"GitHub"` or `"Weblate"`.
45+
46+
- weblate:
47+
48+
Whether the entry should be included in Weblate. One of `"include"`,
49+
`"exclude"`, or `NA`.
50+
51+
## Value
52+
53+
An updated glossary data frame.
54+
55+
## Details
56+
57+
Existing entries are identified using the English term. New entries are
58+
added to the glossary.
59+
60+
## Examples
61+
62+
``` r
63+
updated_glossary <- update_glossary(
64+
glossary = glossary,
65+
english = "data frame",
66+
spanish = "marco de datos",
67+
updated_via = "GitHub",
68+
weblate = "include"
69+
)
70+
#> Error: object 'glossary' not found
71+
```

0 commit comments

Comments
 (0)