REditorSupport / REditorSupport/vscode-R
wiki: suggestion and typo
Open
Beginner friendly
Nobody has claimed this yet.
bug
- Dominant language
- TypeScript
- Stars
- 1.2k
- Forks
- 139
- Avg merge
- 2h 46m
- Merged PRs (30d)
- 5
Description
The Diagnostics section should mention lintr, e.g.:
The language server provides code diagnostics through the [lintr](https://lintr.r-lib.org/) package in R. See [here](https://github.com/REditorSupport/vscode-R/wiki/Code-linting) for configuration.
and in the table of content:
-[Diagnose potential errors and unreliable code](https://github.com/REditorSupport/vscode-R/wiki/R-Language-Service#diagnostics)
+[Diagnose with `lintr` potential errors and unreliable code](https://github.com/REditorSupport/vscode-R/wiki/R-Language-Service#diagnostics)
(same wording as for the reference to styler in the Formatting section and table of content)
There is a typo in the Formatting section:
-The language server provides code formatting through the through the [styler](https://github.com/r-lib/styler) package in R. See [here](https://github.com/REditorSupport/languageserver#customizing-formatting-style) for configuration.
+The language server provides code formatting through the [styler](https://github.com/r-lib/styler) package in R. See [here](https://github.com/REditorSupport/languageserver#customizing-formatting-style) for configuration.
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.
Research direction
Open the R-Language-Service wiki page and review its Diagnostics and Formatting sections plus the table of contents. Add the lintr description and link, update the diagnostics wording, and remove the duplicated “through the” in the styler sentence. Done means both wiki sections and their table-of-contents entries match the wording requested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 70/100