Outdated pieces of vignettes
@mahjabinoyshi is already working on this.
Since Jun 9, 2026.
Assessment
This issue has not been assessed yet.
Description
I pointed an LLM at our vignettes with the intention to find anything obvious we should update, and it found some quick obvious improvements:
Recommendations for Updates
- Remove Broken Links: Update datatable-intro.Rmd and datatable-reference-semantics.Rmd to either remove references to the "data.table design" vignette or replace them with links to relevant sections in the Wiki or other existing vignettes (like datatable-sd-usage.Rmd or benchmarking).
- Update Reference Semantics: Update the shallow copy comment in datatable-reference-semantics.Rmd to reflect the current state of internal optimizations and remove the reference to v1.9.8 as a future target.
- Modernize FAQs: Add the
envargument as a recommended solution in FAQ 1.5 and FAQ 2.14, pointing users to the datatable-programming.Rmd vignette for deeper understanding.\
This does not, of course, preclude further improvements missed by this simple one-shot check on documentation quality.
- Dominant language
- R
- Stars
- 3.9k
- Forks
- 1.1k
- Avg merge
- 14h 4m
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Rdatatable/data.table
-
as.data.table() recurses without end on a survival::Surv object (or any data.frame carrying one) Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Rdatatable/data.table#7887 ·
-
consistency tests
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Rdatatable/data.table#7853 · 3 comments ·
-
internals
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Rdatatable/data.table#6938 · 1 comment ·
-
encoding fread
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Rdatatable/data.table#5179 · 8 comments ·
-
documentation programming
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Rdatatable/data.table#3199 · 3 comments ·
All issues in Rdatatable/data.table
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
r-lib/pkgdepends#485 · 3 comments ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
beginners blocker
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enviPathR OpenBuild Error Build OK Build Warning policies-accepted pre-review precheck-passed
Difficulty 1/5 Under an hour Newbie friendliness 84/100
Bioconductor/BiocContributions#207 · 6 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
datacarpentry/semester-biology#1255 ·