Epic: Formatting comments
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 446
- Forks
- 32
- Avg merge
- 16h 48m
- Merged PRs (30d)
- 1
Description
Not planned in the short term but gathering ideas and concerns here:
-
Roxygen (whole project in itself, will probably require a parser extension)
-
Enforce space between comment sign and first character. Allow comment sign to be repeated and suffixed with a special character.
-
Line length: 72 characters as in PEP8? https://peps.python.org/pep-0008/#maximum-line-length
Prose is much easier to read with a small ligne length in general.
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
This epic lists possible comment-formatting ideas, including Roxygen support, comment spacing, repeated comment signs, and line length, but names no files, tests, or entry points. No concrete completion criteria are defined, so the scope and definition of done would need to be established before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r, rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100